Skip to content

Commit ea408af

Browse files
flippedcoderdustin-temporalclaudebrianmacdonald-temporalnishkrishnan
authored
Deprecate PromQL endpoint, promote OpenMetrics to GA (#4374)
- Add deprecation notices to PromQL-related pages (reference, general-setup, prometheus-grafana, promql) with April 2 2026 deprecation and October 5 2026 disable dates - Rewrite cloud/metrics landing page: title to "Temporal Cloud Metrics", lead with OpenMetrics, move PromQL to deprecated section at bottom - Remove Public Preview designations from all OpenMetrics pages - Update migration guide timeline with concrete deprecation dates - Change OpenMetrics data lookback from 2 minutes to 3 minutes Co-authored-by: Dustin Cote <dustin.cote@temporal.io> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Brian MacDonald <brian.macdonald@temporal.io> Co-authored-by: Nish Krishnan <nishkrishnan@users.noreply.github.com>
1 parent 6f5bb44 commit ea408af

10 files changed

Lines changed: 83 additions & 69 deletions

File tree

docs/cloud/metrics/general-setup.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ tags:
2323

2424
import { RelatedReadContainer, RelatedReadItem } from '@site/src/components';
2525

26+
:::danger PromQL endpoint deprecated
27+
28+
The PromQL endpoint and its `temporal_cloud_v0_*` metrics were deprecated on April 2, 2026 and are no longer accepting new users.
29+
The PromQL endpoint will be disabled for all users on **October 5, 2026**.
30+
31+
New users should set up the [OpenMetrics endpoint](/cloud/metrics/openmetrics) instead.
32+
Existing users should follow the [migration guide](/cloud/metrics/openmetrics/migration-guide) to transition to the OpenMetrics endpoint.
33+
34+
:::
35+
2636
You will learn how to do the following:
2737

2838
- [Configure an endpoint using the UI](#configure-via-ui)

docs/cloud/metrics/index.mdx

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
id: index
3-
title: Temporal Cloud Observability and Metrics
3+
title: Temporal Cloud Metrics
44
sidebar_label: Metrics
5-
description: Get detailed insights using the Temporal SDK and Cloud Metrics.
5+
description: Monitor Temporal Cloud workloads with Cloud metrics and SDK metrics.
66
slug: /cloud/metrics/
77
toc_max_heading_level: 4
88
keywords:
@@ -21,29 +21,42 @@ tags:
2121
- Temporal Cloud
2222
---
2323

24-
Temporal offers two distinct sources of metrics: [Cloud/Server Metrics](/cloud/metrics/reference) and [SDK Metrics](/references/sdk-metrics).
25-
Each source provides options for levels of granularity and filtering, monitoring-tool integrations, and configuration.
26-
Before implementing Temporal Cloud observability, decide what you need to measure for your use case. There are two primary use cases for metrics:
24+
Temporal offers two distinct sources of metrics: [Cloud Metrics](/cloud/metrics/openmetrics/metrics-reference) and [SDK Metrics](/references/sdk-metrics).
25+
Each source provides different levels of granularity, filtering options, monitoring-tool integrations, and configuration.
2726

28-
- To measure the health and performance of Temporal-backed applications and key business processes.
29-
- To measure the health and performance of Temporal infrastructure and user provided infrastructure in the form of Temporal Workers and Temporal Clients.
27+
- **SDK metrics** monitor individual Workers and your code's behavior from the perspective of your application.
28+
- **Cloud metrics** monitor Temporal Cloud's behavior from the perspective of the Temporal Service.
3029

31-
When measuring the performance of Temporal-backed applications and key business processes, you should rely on Temporal SDK metrics as a source of truth.
32-
This is because Temporal SDKs provide visibility from the perspective of your application, not from the perspective of the Temporal Service.
30+
When used together, Cloud and SDK metrics measure the health and performance of your full Temporal infrastructure, including the Temporal Cloud Service and user-supplied Temporal Workers.
3331

34-
SDK metrics monitor individual workers and your code's behavior.
35-
Cloud metrics monitor Temporal behavior.
36-
When used together, Temporal Cloud and SDK metrics measure the health and performance of your full Temporal infrastructure, including the Temporal Cloud Service and user-supplied Temporal Workers.
32+
## Cloud Metrics
3733

38-
Cloud Metrics for all Namespaces in your account are available from two sources:
34+
Cloud metrics for all Namespaces in your account are available from the [OpenMetrics endpoint](/cloud/metrics/openmetrics), a Prometheus-compatible scrapable endpoint at `metrics.temporal.io`.
3935

40-
- [OpenMetrics Endpoint](/cloud/metrics/openmetrics) - A Prometheus-compatible scrapable endpoint.
41-
- [PromQL Endpoint](/cloud/metrics/promql) - A Prometheus query endpoint.
36+
- [OpenMetrics overview](/cloud/metrics/openmetrics) - Getting started and key concepts
37+
- [Metrics integrations](/cloud/metrics/openmetrics/metrics-integrations) - Datadog, Grafana Cloud, New Relic, ClickStack, and more
38+
- [API reference](/cloud/metrics/openmetrics/api-reference) - Endpoint specification and advanced configuration
39+
- [Metrics reference](/cloud/metrics/openmetrics/metrics-reference) - Complete catalog of all `temporal_cloud_v1_*` metrics
4240

43-
:::note
41+
## SDK Metrics
4442

45-
OpenMetrics is the recommended option for most users.
43+
SDK metrics are emitted by your Workers and Clients.
44+
For setup instructions, see [SDK metrics setup](/cloud/metrics/sdk-metrics-setup).
45+
46+
## PromQL Endpoint (Deprecated) {#promql-deprecated}
47+
48+
:::danger PromQL endpoint deprecated
49+
50+
The PromQL endpoint and its `temporal_cloud_v0_*` metrics were deprecated on April 2, 2026 and are no longer accepting new users.
51+
The PromQL endpoint will be disabled for all users on **October 5, 2026**.
52+
53+
Migrate to the [OpenMetrics endpoint](/cloud/metrics/openmetrics).
54+
See the [migration guide](/cloud/metrics/openmetrics/migration-guide) for a complete v0-to-v1 metric mapping.
4655

4756
:::
4857

49-
For setting up SDK metrics emitted by your Workers and Clients, see [SDK metrics setup](/cloud/metrics/sdk-metrics-setup).
58+
The legacy PromQL endpoint uses mTLS certificate authentication and exposes `temporal_cloud_v0_*` metrics via a Prometheus query API.
59+
60+
- [PromQL endpoint](/cloud/metrics/promql)
61+
- [PromQL metrics reference](/cloud/metrics/reference)
62+
- [PromQL setup with Grafana](/cloud/metrics/prometheus-grafana)

docs/cloud/metrics/openmetrics/api-reference.mdx

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,6 @@ import { CaptionedImage } from '@site/src/components';
2525

2626
The Temporal Cloud OpenMetrics API provides actionable operational metrics about your Temporal Cloud deployment. This is a scrapable HTTP API that returns metrics in OpenMetrics format, suitable for ingestion by Prometheus-compatible monitoring systems.
2727

28-
:::tip SUPPORT, STABILITY, and DEPENDENCY INFO
29-
30-
Temporal Cloud OpenMetrics support is available in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).
31-
32-
:::
3328

3429
## Available Metrics Reference
3530

@@ -134,7 +129,7 @@ Implement retry logic in your client to gracefully handle transient API failures
134129

135130
### Data Latency
136131

137-
Metric data points are available for query within 2 minutes of their origination. This is in line with the freshest metrics [available from any major service provider](https://docs.datadoghq.com/integrations/guide/cloud-metric-delay/). This latency should be accounted for when setting up monitoring alerts.
132+
Metric data points are available for query within 3 minutes of their origination. This is in line with the freshest metrics [available from any major service provider](https://docs.datadoghq.com/integrations/guide/cloud-metric-delay/). This latency should be accounted for when setting up monitoring alerts.
138133

139134
## Endpoints
140135

@@ -152,7 +147,7 @@ Returns metrics in OpenMetrics format suitable for scraping by Prometheus-compat
152147

153148
#### Timestamp Offset
154149

155-
To account for metric data latency, this endpoint returns metrics from the current timestamp minus a fixed offset. The current offset is 2 minutes rounded down to the start of the minute. To accommodate this offset, the timestamps in the response should be honored when importing the metrics. For example, in Prometheus this can be controlled using the `honor\_timestamps` flag.
150+
To account for metric data latency, this endpoint returns metrics from the current timestamp minus a fixed offset. The current offset is 3 minutes rounded down to the start of the minute. To accommodate this offset, the timestamps in the response should be honored when importing the metrics. For example, in Prometheus this can be controlled using the `honor\_timestamps` flag.
156151

157152
#### Query Parameters
158153

docs/cloud/metrics/openmetrics/index.mdx

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,6 @@ tags:
2222
- Temporal Cloud
2323
---
2424

25-
:::tip SUPPORT, STABILITY, and DEPENDENCY INFO
26-
27-
Temporal Cloud OpenMetrics support is available in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).
28-
29-
:::
3025

3126
:::tip PRICING
3227

@@ -43,7 +38,7 @@ Temporal Cloud's [OpenMetrics](https://openmetrics.io/) endpoint provides operat
4338
* [Migration Guide](/cloud/metrics/openmetrics/migration-guide) - Guide on how to transition from the Prometheus query endpoint
4439

4540
## Overview
46-
Temporal Cloud OpenMetrics exposes 50+ metrics covering workflow lifecycles, task queue operations, service performance, and system limits. All metrics are aggregated over one-minute windows and available for scraping within two minutes.
41+
Temporal Cloud OpenMetrics exposes 50+ metrics covering workflow lifecycles, task queue operations, service performance, and system limits. All metrics are aggregated over one-minute windows and available for scraping within three minutes.
4742

4843
* [Set up authentication and scraping](/cloud/metrics/openmetrics/api-reference#authentication) with the API documentation.
4944
* Browse the [complete metrics catalog](/cloud/metrics/openmetrics/metrics-reference) for descriptions and labels.

docs/cloud/metrics/openmetrics/metrics-integrations.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,6 @@ Metrics can be exported from Temporal Cloud using the OpenMetrics endpoint. This
2727
This document is for basic configuration only. For advanced concepts such as label management and high cardinality scenarios see the
2828
[general API reference](/cloud/metrics/openmetrics/api-reference).
2929

30-
:::tip SUPPORT, STABILITY, and DEPENDENCY INFO
31-
32-
Temporal Cloud OpenMetrics support is available in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).
33-
34-
:::
3530

3631
## Integrations
3732

docs/cloud/metrics/openmetrics/metrics-reference.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,6 @@ tags:
2323

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

26-
:::tip SUPPORT, STABILITY, and DEPENDENCY INFO
27-
28-
Temporal Cloud OpenMetrics support is available in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).
29-
30-
:::
3126

3227
## Metric Conventions
3328

docs/cloud/metrics/openmetrics/migration-guide.mdx

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ Temporal Cloud is transitioning from our Prometheus query endpoint to an industr
2929
can monitor your Temporal Cloud workloads, bringing enhanced capabilities, better integration with observability tools,
3030
and access to high-cardinality metrics that were previously unavailable.
3131

32-
:::tip SUPPORT, STABILITY, and DEPENDENCY INFO
32+
:::danger PromQL endpoint deprecated
3333

34-
The OpenMetrics endpoint is available in
35-
[Public Preview](/evaluate/development-production-features/release-stages#public-preview) for testing and validation.
36-
The existing Prometheus query endpoint remains fully operational and supported.
34+
The PromQL endpoint was deprecated on April 2, 2026 and is no longer accepting new users.
35+
The PromQL endpoint will be disabled for all users on **October 5, 2026**.
36+
Complete your migration to the OpenMetrics endpoint before this date.
3737

3838
:::
3939

@@ -52,7 +52,7 @@ The existing Prometheus query endpoint remains fully operational and supported.
5252
4. **Simplified Integration**: Direct scraping from your observability tools without intermediate translation layers.
5353

5454
5. **Enhanced Performance**: Optimized for high-cardinality data with built-in safeguards for system stability. Data is
55-
available to scrape two minutes from the time it was emitted, in line with the freshest metrics
55+
available to scrape three minutes from the time it was emitted, in line with the freshest metrics
5656
[available from any major service provider](https://docs.datadoghq.com/integrations/guide/cloud-metric-delay/).
5757

5858
## What's Changing
@@ -68,30 +68,19 @@ The existing Prometheus query endpoint remains fully operational and supported.
6868

6969
## Migration Timeline
7070

71-
Here is the current estimated timeline for migrating from the Prometheus query endpoint to the OpenMetrics endpoint.
71+
**April 2, 2026 - PromQL endpoint deprecated**
7272

73-
:::caution
73+
- The PromQL endpoint is no longer accepting new users.
74+
- Existing users should begin migrating to the OpenMetrics endpoint.
7475

75-
Timelines can shift so be sure to stay up to date on upcoming releases.
76+
**October 5, 2026 - PromQL endpoint disabled**
7677

77-
:::
78-
79-
**Public Preview (Current)**
80-
81-
- OpenMetrics endpoint available for onboarding.
82-
- Both endpoints run in parallel with no changes required.
83-
84-
**General Availability [TBA]**:
85-
86-
- OpenMetrics endpoint becomes production-ready and the standard for metrics collection.
87-
88-
**Query Endpoint Deprecation (6 months after GA)**:
89-
90-
- Prometheus query endpoint deprecated and eventually removed.
78+
- The PromQL endpoint will be disabled for all users.
79+
- All metrics consumption must use the OpenMetrics endpoint by this date.
9180

9281
:::important Action Required
9382

94-
Complete migration before the 6 month deprecation window ends.
83+
Complete migration before October 5, 2026.
9584

9685
:::
9786

docs/cloud/metrics/prometheus-grafana.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,15 @@ tags:
2525

2626
import { ZoomingImage } from '@site/src/components';
2727

28+
:::danger PromQL endpoint deprecated
29+
30+
The PromQL endpoint and its `temporal_cloud_v0_*` metrics were deprecated on April 2, 2026 and are no longer accepting new users.
31+
The PromQL endpoint will be disabled for all users on **October 5, 2026**.
32+
33+
For Grafana setup with the OpenMetrics endpoint, see the [OpenMetrics integrations page](/cloud/metrics/openmetrics/metrics-integrations).
34+
35+
:::
36+
2837
**How to set up Grafana with Temporal Cloud PromQL endpoint to view Cloud metrics.**
2938

3039
Temporal Cloud emits metrics through a [Prometheus HTTP API endpoint](https://prometheus.io/docs/prometheus/latest/querying/api/), which can be directly used as a Prometheus data source in Grafana or to query and export Cloud metrics to any observability platform.

docs/cloud/metrics/promql.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ tags:
2121
- Temporal Cloud
2222
---
2323

24-
:::tip
24+
:::danger PromQL endpoint deprecated
2525

26-
Need to scrape metrics into your observability stack? Try out the new [OpenMetrics endpoint](/cloud/metrics/openmetrics).
26+
The PromQL endpoint and its `temporal_cloud_v0_*` metrics were deprecated on April 2, 2026 and are no longer accepting new users.
27+
The PromQL endpoint will be disabled for all users on **October 5, 2026**.
28+
29+
Migrate to the [OpenMetrics endpoint](/cloud/metrics/openmetrics).
30+
See the [migration guide](/cloud/metrics/openmetrics/migration-guide) for a complete v0-to-v1 metric mapping.
2731

2832
:::
2933

docs/cloud/metrics/reference.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,19 @@ keywords:
2626
- gRPC error count
2727
---
2828

29+
:::danger PromQL endpoint deprecated
30+
31+
The PromQL endpoint and its `temporal_cloud_v0_*` metrics were deprecated on April 2, 2026 and are no longer accepting new users.
32+
The PromQL endpoint will be disabled for all users on **October 5, 2026**.
33+
34+
Migrate to the [OpenMetrics endpoint](/cloud/metrics/openmetrics) which provides `temporal_cloud_v1_*` metrics with higher cardinality, accurate percentiles, and simplified authentication.
35+
See the [migration guide](/cloud/metrics/openmetrics/migration-guide) for a complete v0-to-v1 metric mapping.
36+
37+
:::
38+
2939
A metric is a measurement or data point that provides insights into the performance and health of a system.
30-
This document describes the metrics available on the Temporal Cloud platform.
31-
Temporal Cloud metrics help you monitor performance and troubleshoot errors.
32-
They provide insights into different aspects of the Service.
40+
This document describes the `temporal_cloud_v0_*` metrics available from the deprecated Temporal Cloud PromQL endpoint.
41+
For the current metrics reference, see the [OpenMetrics metrics reference](/cloud/metrics/openmetrics/metrics-reference).
3342

3443
This document describes:
3544

0 commit comments

Comments
 (0)