From 00a581dd5f90440d24eb01e288612a65881a17b1 Mon Sep 17 00:00:00 2001 From: Dustin Cote Date: Tue, 18 Aug 2026 15:56:01 -0400 Subject: [PATCH 1/5] Document Temporal Cloud Schedule metrics --- .../metrics/openmetrics/metrics-reference.mdx | 37 ++++++++++++++++--- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/docs/cloud/metrics/openmetrics/metrics-reference.mdx b/docs/cloud/metrics/openmetrics/metrics-reference.mdx index 95f65e4ad8..346d517bf5 100644 --- a/docs/cloud/metrics/openmetrics/metrics-reference.mdx +++ b/docs/cloud/metrics/openmetrics/metrics-reference.mdx @@ -667,28 +667,56 @@ Operations throttled due to rate limits per second. See [Monitoring Trends Again #### temporal\_cloud\_v1\_schedule\_action\_success\_count -Successfully executed scheduled workflows per second. +Successful scheduled executions per second. **Type**: Rate #### temporal\_cloud\_v1\_schedule\_buffer\_overruns\_count -The rate of schedule buffer overruns when using `BUFFER_ALL` overlap policy. +Scheduled executions dropped per second because the Schedule's internal Action buffer is full. This metric is distinct from overlap skips and Catchup Window misses and includes backfill Actions. **Type**: Rate #### temporal\_cloud\_v1\_schedule\_missed\_catchup\_window\_count -The rate of missed schedule executions outside the catchup window. +Scheduled executions permanently dropped per second because they fell outside the Catchup Window. This metric is not emitted for backfills. **Type**: Rate #### temporal\_cloud\_v1\_schedule\_rate\_limited\_count -The rate of scheduled workflows delayed due to rate limiting. +Scheduled executions delayed per second due to rate limiting. **Type**: Rate +#### temporal\_cloud\_v1\_schedule\_overlap\_skipped\_count + +Schedule executions dropped per second due to the overlap policy. This metric is emitted for `SKIP` when another execution is running or already selected, and for `BUFFER_ONE` when its single buffered slot is occupied. It can also be emitted during backfills that use `SKIP` or `BUFFER_ONE`. A sustained rate can indicate that executions are generated faster than they complete. + +| Label | Description | +| ----- | ----- | +| `schedule_overlap_policy` | The overlap policy that caused the execution to be dropped | + +**Type**: Rate + +#### temporal\_cloud\_v1\_schedule\_action\_delay\_p50 + +The 50th percentile delay in seconds between an execution becoming eligible to start and its actual start. Eligibility is determined after any overlap-policy wait, which the metric excludes. This metric is not emitted for backfills. + +**Type**: Latency + +#### temporal\_cloud\_v1\_schedule\_action\_delay\_p95 + +The 95th percentile delay in seconds between an execution becoming eligible to start and its actual start. Eligibility is determined after any overlap-policy wait, which the metric excludes. This metric is not emitted for backfills. + +**Type**: Latency + +#### temporal\_cloud\_v1\_schedule\_action\_delay\_p99 + +The 99th percentile delay in seconds between an execution becoming eligible to start and its actual start. Eligibility is determined after any overlap-policy wait, which the metric excludes. This metric is not emitted for backfills. + +**Type**: Latency + ### Replication Metrics #### temporal\_cloud\_v1\_replication\_lag\_p50 @@ -782,4 +810,3 @@ Does not include the `region` label. Provisioned capacity is scoped to the Names ::: **Type**: Value - From cd5a61899a1a97168aaf00baba8f31fe32484e78 Mon Sep 17 00:00:00 2001 From: Dustin Cote Date: Wed, 19 Aug 2026 14:44:24 -0400 Subject: [PATCH 2/5] drop action delay latency metrics for now --- .../metrics/openmetrics/metrics-reference.mdx | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/docs/cloud/metrics/openmetrics/metrics-reference.mdx b/docs/cloud/metrics/openmetrics/metrics-reference.mdx index 346d517bf5..9c15810a07 100644 --- a/docs/cloud/metrics/openmetrics/metrics-reference.mdx +++ b/docs/cloud/metrics/openmetrics/metrics-reference.mdx @@ -699,24 +699,6 @@ Schedule executions dropped per second due to the overlap policy. This metric is **Type**: Rate -#### temporal\_cloud\_v1\_schedule\_action\_delay\_p50 - -The 50th percentile delay in seconds between an execution becoming eligible to start and its actual start. Eligibility is determined after any overlap-policy wait, which the metric excludes. This metric is not emitted for backfills. - -**Type**: Latency - -#### temporal\_cloud\_v1\_schedule\_action\_delay\_p95 - -The 95th percentile delay in seconds between an execution becoming eligible to start and its actual start. Eligibility is determined after any overlap-policy wait, which the metric excludes. This metric is not emitted for backfills. - -**Type**: Latency - -#### temporal\_cloud\_v1\_schedule\_action\_delay\_p99 - -The 99th percentile delay in seconds between an execution becoming eligible to start and its actual start. Eligibility is determined after any overlap-policy wait, which the metric excludes. This metric is not emitted for backfills. - -**Type**: Latency - ### Replication Metrics #### temporal\_cloud\_v1\_replication\_lag\_p50 From 3eb0b934adc9a1c18e690cae45665536c53908c2 Mon Sep 17 00:00:00 2001 From: Dustin Cote Date: Thu, 20 Aug 2026 09:20:43 -0400 Subject: [PATCH 3/5] clarify rate limit metric role/future --- docs/cloud/metrics/openmetrics/metrics-reference.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cloud/metrics/openmetrics/metrics-reference.mdx b/docs/cloud/metrics/openmetrics/metrics-reference.mdx index 9c15810a07..6b15b14f15 100644 --- a/docs/cloud/metrics/openmetrics/metrics-reference.mdx +++ b/docs/cloud/metrics/openmetrics/metrics-reference.mdx @@ -685,7 +685,7 @@ Scheduled executions permanently dropped per second because they fell outside th #### temporal\_cloud\_v1\_schedule\_rate\_limited\_count -Scheduled executions delayed per second due to rate limiting. +[DEPRECATED] Scheduled executions delayed per second due to rate limiting. This metric is in the process of being replaced by standard request per second rate limit monitoring with dynamic scaling. This metric will be removed when this change is rolled out to all of Temporal Cloud. **Type**: Rate From 74ed0f0ca0054b4419a7574772146fec17dbc7cc Mon Sep 17 00:00:00 2001 From: Dustin Cote Date: Thu, 20 Aug 2026 12:48:58 -0400 Subject: [PATCH 4/5] schedule buffer action description generalization --- docs/cloud/metrics/openmetrics/metrics-reference.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cloud/metrics/openmetrics/metrics-reference.mdx b/docs/cloud/metrics/openmetrics/metrics-reference.mdx index 6b15b14f15..75759da41a 100644 --- a/docs/cloud/metrics/openmetrics/metrics-reference.mdx +++ b/docs/cloud/metrics/openmetrics/metrics-reference.mdx @@ -673,7 +673,7 @@ Successful scheduled executions per second. #### temporal\_cloud\_v1\_schedule\_buffer\_overruns\_count -Scheduled executions dropped per second because the Schedule's internal Action buffer is full. This metric is distinct from overlap skips and Catchup Window misses and includes backfill Actions. +Scheduled executions dropped per second because the Schedule's internal Action buffer is full. **Type**: Rate From 606979a377540a6aa546705bf5e83fe6d8e714b7 Mon Sep 17 00:00:00 2001 From: Dustin Cote Date: Thu, 20 Aug 2026 14:39:48 -0400 Subject: [PATCH 5/5] Document metric release stages --- docs/cloud/metrics/openmetrics/api-reference.mdx | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/cloud/metrics/openmetrics/api-reference.mdx b/docs/cloud/metrics/openmetrics/api-reference.mdx index 2be6e66894..437712f4aa 100644 --- a/docs/cloud/metrics/openmetrics/api-reference.mdx +++ b/docs/cloud/metrics/openmetrics/api-reference.mdx @@ -90,7 +90,7 @@ Common labels include: Each metric has its own set of applicable labels. See the Metrics Reference for complete details. -### Metric Family +### Metric family A [Metric Family](https://github.com/prometheus/OpenMetrics/blob/main/specification/OpenMetrics.md#metricfamily) may have zero or more metrics. The set of metrics returned will vary based on actual system activity. Metrics only appear in a Metric Family if they were reported during the aggregation window. @@ -220,7 +220,15 @@ temporal_cloud_v1_approximate_backlog_count{temporal_namespace="production",temp `GET /v1/descriptors` -Lists all metric descriptors including metadata, data types, and available dimensions (a.k.a. labels). +Lists all metric descriptors, including help text, available dimensions (labels), and release stages. + +Each descriptor includes a `release_stage` field that reports the metric's lifecycle status. The supported values are: + +| Value | Description | +| ----- | ----- | +| `public-preview` | The metric is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview) | +| `general-availability` | The metric is in [General Availability](/evaluate/development-production-features/release-stages#general-availability) | +| `deprecated` | The metric is deprecated | #### Query parameters @@ -258,7 +266,8 @@ Response: "temporal_workflow_type", "temporal_task_queue", "region" - ] + ], + "release_stage": "general-availability" } ] }