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" } ] } diff --git a/docs/cloud/metrics/openmetrics/metrics-reference.mdx b/docs/cloud/metrics/openmetrics/metrics-reference.mdx index 95f65e4ad8..75759da41a 100644 --- a/docs/cloud/metrics/openmetrics/metrics-reference.mdx +++ b/docs/cloud/metrics/openmetrics/metrics-reference.mdx @@ -667,25 +667,35 @@ 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. **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. +[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 + +#### 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 @@ -782,4 +792,3 @@ Does not include the `region` label. Provisioned capacity is scoped to the Names ::: **Type**: Value -