Skip to main content

OpenMetrics metrics reference

This document describes all metrics available from the Temporal Cloud OpenMetrics endpoint.

Metric Conventions​

Metric Types​

All metrics are exposed as OpenMetrics gauges, but represent different measurement types:

  • Rate Metrics: per-second rate of the aggregated values
  • Value Metrics: The most recent aggregate value within a look-back window (e.g. backlogs, limits)
  • Percentile Metrics: Pre-calculated aggregated latency percentiles in seconds
note

All metrics are stored as 1 minute aggregates.

Common Labels​

All metrics include these base labels:

LabelDescription
temporal_namespaceThe Temporal namespace
temporal_accountThe Temporal account identifier
regionCloud region where the metric originated

Opt-in Labels​

Some labels are opt-in due to their high cardinality. These labels are not included by default when you scrape the OpenMetrics endpoint. To enable an opt-in label, add it to the labels query parameter on your scrape URL. When an opt-in label is enabled, it is populated on all metrics that support it.

LabelAvailable onDescription
temporal_activity_typeActivity metricsThe activity type name
temporal_worker_deployment_nametemporal_cloud_v1_approximate_backlog_countThe Worker Deployment name
temporal_worker_build_idtemporal_cloud_v1_approximate_backlog_countThe Worker Deployment Version Build ID
worker_versiontemporal_cloud_v1_approximate_backlog_countDeprecated. The legacy Worker Build ID from the pre-Worker-Deployments versioning API. Use temporal_worker_deployment_name and temporal_worker_build_id instead

For example, to include temporal_activity_type in your scrape results:

/v1/metrics?labels=temporal_activity_type

Enable multiple labels at the same time by concatenating multiple labels query parameters:

/v1/metrics?labels=temporal_worker_build_id&labels=temporal_worker_deployment_name

Metrics Catalog​

Frontend Service Metrics​

temporal_cloud_v1_service_request_count​

gRPC requests received per second.

LabelDescription
operationThe name of the RPC operation

Type: Rate

temporal_cloud_v1_service_request_throttled_count​

gRPC requests throttled per second.

LabelDescription
operationThe name of the RPC operation

Type: Rate

temporal_cloud_v1_service_error_count​

gRPC errors per second.

LabelDescription
operationThe name of the RPC operation

Type: Rate

temporal_cloud_v1_service_pending_requests​

The number of pollers that are actively long polling for a task. Use this to track against temporal_cloud_v1_poller_limit

LabelDescription
operationThe name of the operation

Type: Value

temporal_cloud_v1_resource_exhausted_error_count​

Resource exhaustion errors per second. This metric does not include throttling due to Namespace limits.

LabelDescription
operationThe name of the operation

Type: Rate

temporal_cloud_v1_service_latency_p50​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 50th percentile latency of service requests in seconds

LabelDescription
operationThe name of the operation

Type: Latency

temporal_cloud_v1_service_latency_p95​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 95th percentile latency of service requests in seconds

LabelDescription
operationThe name of the operation

Type: Latency

temporal_cloud_v1_service_latency_p99​

caution

Avoid aggregating this metric across dimensions as the percentile won't be accurate.

The 99th percentile latency of service requests in seconds

LabelDescription
operationThe name of the operation

Type: Latency

Workflow Completion Metrics​

High Cardinality

These metrics could have high cardinality depending on number of workflow types and task queues.

temporal_cloud_v1_workflow_success_count​

Successful workflow completions per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type

Type: Rate

temporal_cloud_v1_workflow_failed_count​

Workflow failures per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type

Type: Rate

temporal_cloud_v1_workflow_timeout_count​

Workflow timeouts per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type

Type: Rate

temporal_cloud_v1_workflow_cancel_count​

Workflow cancellations per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type

Type: Rate

temporal_cloud_v1_workflow_terminate_count​

Workflow terminations per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type

Type: Rate

temporal_cloud_v1_workflow_continued_as_new_count​

Workflows continued as new per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type

Type: Rate

temporal_cloud_v1_workflow_schedule_to_close_latency_p50​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 50th percentile workflow schedule-to-close latency in seconds.

LabelDescription
temporal_workflow_typeThe workflow type

Type: Latency

temporal_cloud_v1_workflow_schedule_to_close_latency_p95​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 95th percentile workflow schedule-to-close latency in seconds.

LabelDescription
temporal_workflow_typeThe workflow type

Type: Latency

temporal_cloud_v1_workflow_schedule_to_close_latency_p99​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 99th percentile workflow schedule-to-close latency in seconds.

LabelDescription
temporal_workflow_typeThe workflow type

Type: Latency

Activity Metrics​

High Cardinality

These metrics could have high cardinality depending on number of activity types, workflow types, and task queues. The temporal_activity_type label is opt-in to help manage cardinality.

Standalone Activities

Standalone Activities are Activity Executions that are started independently, without an associated Workflow. For Activity metrics that include the temporal_workflow_type label, Standalone Activities use the placeholder value "__standalone_activity".

temporal_cloud_v1_activity_success_count​

Successful activity completions per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type
temporal_activity_typeThe activity type (opt-in)

Type: Rate

temporal_cloud_v1_activity_fail_count​

Activity failures per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type
temporal_activity_typeThe activity type (opt-in)

Type: Rate

temporal_cloud_v1_activity_timeout_count​

Activity timeouts per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type
temporal_activity_typeThe activity type (opt-in)
timeout_typeThe timeout type

Type: Rate

temporal_cloud_v1_activity_task_fail_count​

Activity task failures per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type
temporal_activity_typeThe activity type (opt-in)

Type: Rate

temporal_cloud_v1_activity_task_timeout_count​

Activity task timeouts per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type
temporal_activity_typeThe activity type (opt-in)
timeout_typeThe timeout type

Type: Rate

temporal_cloud_v1_activity_cancel_count​

Activity cancellations per second.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type
temporal_activity_typeThe activity type (opt-in)

Type: Rate

temporal_cloud_v1_activity_terminate_count​

Activity terminations per second. This metric only applies to Standalone Activities. Regular Activities that run within a Workflow cannot be terminated independently.

LabelDescription
temporal_task_queueThe task queue name
temporal_workflow_typeThe workflow type
temporal_activity_typeThe activity type (opt-in)

Type: Rate

Activity latency labels

Activity latency metrics include only the temporal_activity_type label. Labels such as temporal_task_queue and temporal_workflow_type are intentionally excluded because pre-calculated percentile values cannot be accurately aggregated across additional dimensions.

temporal_cloud_v1_activity_start_to_close_latency_p50​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 50th percentile activity start-to-close latency in seconds.

LabelDescription
temporal_activity_typeThe activity type (opt-in)

Type: Latency

temporal_cloud_v1_activity_start_to_close_latency_p95​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 95th percentile activity start-to-close latency in seconds.

LabelDescription
temporal_activity_typeThe activity type (opt-in)

Type: Latency

temporal_cloud_v1_activity_start_to_close_latency_p99​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 99th percentile activity start-to-close latency in seconds.

LabelDescription
temporal_activity_typeThe activity type (opt-in)

Type: Latency

temporal_cloud_v1_activity_schedule_to_close_latency_p50​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 50th percentile activity schedule-to-close latency in seconds.

LabelDescription
temporal_activity_typeThe activity type (opt-in)

Type: Latency

temporal_cloud_v1_activity_schedule_to_close_latency_p95​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 95th percentile activity schedule-to-close latency in seconds.

LabelDescription
temporal_activity_typeThe activity type (opt-in)

Type: Latency

temporal_cloud_v1_activity_schedule_to_close_latency_p99​

caution

Avoid aggregating this metric across dimensions because the percentile won't be accurate.

The 99th percentile activity schedule-to-close latency in seconds.

LabelDescription
temporal_activity_typeThe activity type (opt-in)

Type: Latency

Task Queue Metrics​

High Cardinality

These metrics could have high cardinality depending on number of task queues present.

temporal_cloud_v1_approximate_backlog_count​

The approximate number of tasks pending in a task queue. Started Activities are not included in the count as they have been dequeued from the task queue.

LabelDescription
temporal_task_queueThe task queue name
task_typeType of task: workflow or activity
task_priorityThe task priority
temporal_worker_deployment_nameThe Worker Deployment name (opt-in)
temporal_worker_build_idThe Worker Deployment Version Build ID (opt-in)
worker_versionDeprecated. The legacy Worker Build ID (opt-in). Use temporal_worker_deployment_name and temporal_worker_build_id instead

Type: Value

temporal_cloud_v1_poll_success_count​

Successfully matched tasks per second.

LabelDescription
operationThe poll operation name
task_typeType of task: workflow or activity
temporal_task_queueThe task queue name

Type: Rate

temporal_cloud_v1_poll_success_sync_count​

Tasks matched synchronously per second (no polling wait).

LabelDescription
operationThe poll operation name
task_typeType of task: workflow or activity
temporal_task_queueThe task queue name

Type: Rate

temporal_cloud_v1_poll_timeout_count​

The rate of poll requests that timed out without receiving a task.

LabelDescription
operationThe poll operation name
task_typeType of task: workflow or activity
temporal_task_queueThe task queue name

Type: Rate

temporal_cloud_v1_no_poller_tasks_count​

The rate of tasks added to queues with no active pollers.

LabelDescription
temporal_task_queueThe task queue name
task_typeType of task: workflow or activity

Type: Rate

Namespace Metrics​

temporal_cloud_v1_namespace_open_workflows​

The current number of open workflows in a namespace.

Type: Value

temporal_cloud_v1_total_action_count​

The total number of actions performed per second. Actions with is_background=false are counted toward the temporal_cloud_v1_action_limit.

LabelDescription
is_backgroundWhether the action was background: true or false. Background actions (e.g. History export) do not count toward the action rate limit
namespace_modeIndicates if actions are produced by an active or a standby Namespace
note

Does not include the region label. Actions are scoped to the Namespace level.

temporal_cloud_v1_billable_action_count​

The number of billable actions per second, broken down by action type and Workflow Type. Not all billable actions are included in this metric; see Actions for details on exceptions.

LabelDescription
action_typeThe action type
temporal_workflow_typeThe workflow type
Public Preview

This metric is currently in Public Preview.

High Cardinality

This metric could have high cardinality depending on number of action types and workflow types.

Type: Rate

temporal_cloud_v1_total_action_throttled_count​

The total number of actions throttled per second.

Type: Rate

temporal_cloud_v1_operations_count​

Operations performed per second.

LabelDescription
operationThe name of the operation
is_backgroundWhether the operation was background: true or false. Background operations do not count toward the operation rate limit
namespace_modeIndicates if operations are produced by an active or a standby Namespace

Type: Rate

temporal_cloud_v1_operations_throttled_count​

Operations throttled due to rate limits per second.

LabelDescription
operationThe name of the operation
is_backgroundWhether the operation was background: true or false. Background operations do not count toward the operation rate limit
namespace_modeIndicates if actions are throttled in an active or a standby Namespace

Type: Rate

Schedule Metrics​

temporal_cloud_v1_schedule_action_success_count​

Successfully executed scheduled workflows per second.

Type: Rate

temporal_cloud_v1_schedule_buffer_overruns_count​

The rate of schedule buffer overruns when using BUFFER_ALL overlap policy.

Type: Rate

temporal_cloud_v1_schedule_missed_catchup_window_count​

The rate of missed schedule executions outside the catchup window.

Type: Rate

temporal_cloud_v1_schedule_rate_limited_count​

The rate of scheduled workflows delayed due to rate limiting.

Type: Rate

Replication Metrics​

temporal_cloud_v1_replication_lag_p50​

The 50th percentile cross-region replication lag in seconds.

Type: Latency

temporal_cloud_v1_replication_lag_p95​

The 95th percentile cross-region replication lag in seconds.

Type: Latency

temporal_cloud_v1_replication_lag_p99​

The 99th percentile cross-region replication lag in seconds.

Type: Latency

Limit Metrics​

temporal_cloud_v1_operations_limit​

The current configured operations per second limit for a namespace.

Type: Value

temporal_cloud_v1_action_limit​

The current configured actions per second limit for a namespace. Track utilization against this limit with temporal_cloud_v1_total_action_count and is_background=false.

Type: Value

temporal_cloud_v1_service_request_limit​

The current configured frontend service RPS limit for a namespace. Track utilization against this limit with temporal_cloud_v1_service_request_count

Type: Value

temporal_cloud_v1_poller_limit​

The current configured poller limit for a namespace. Track utilization against this limit with temporal_cloud_v1_service_pending_requests.

Type: Value

temporal_cloud_v1_action_on_demand_envelope_limit​

The on-demand envelope limit for actions per second. For Namespaces in provisioned capacity mode, this shows what the action limit would be if operating in on-demand mode. For Namespaces already in on-demand mode, this tracks the same value as temporal_cloud_v1_action_limit.

note

Does not include the region label. Limits are scoped to the Namespace level.

Type: Value

temporal_cloud_v1_operations_on_demand_envelope_limit​

The on-demand envelope limit for operations per second. For Namespaces in provisioned capacity mode, this shows what the operations limit would be if operating in on-demand mode. For Namespaces already in on-demand mode, this tracks the same value as temporal_cloud_v1_operations_limit.

note

Does not include the region label. Limits are scoped to the Namespace level.

Type: Value

temporal_cloud_v1_service_request_on_demand_envelope_limit​

The on-demand envelope limit for service requests per second. For Namespaces in provisioned capacity mode, this shows what the service request limit would be if operating in on-demand mode. For Namespaces already in on-demand mode, this tracks the same value as temporal_cloud_v1_service_request_limit.

note

Does not include the region label. Limits are scoped to the Namespace level.

Type: Value