Skip to main content

Metrics Integrations

Metrics can be exported from Temporal Cloud using the OpenMetrics endpoint. This document describes configuring integrations that have third party support or are based on open standards. This document is for basic configuration only. For advanced concepts such as label management and high cardinality scenarios see the general API reference.

SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Cloud OpenMetrics support is available in Public Preview.

Integrations​

Grafana Cloud​

Grafana provides a serverless integration with the OpenMetrics endpoint for Grafana Cloud. This integration will scrape metrics, store them in Grafana Cloud, and provides a default dashboard for visualizing the metrics in Grafana Cloud. See the integration page for more details.

Prometheus + Grafana​

Self hosted Prometheus can be used to scrape the OpenMetrics endpoint.

  1. Add a new scrape job for the OpenMetrics endpoint with your API key.
scrape_configs:
  - job_name: 'temporal-cloud'
    scrape_interval: 60s
    scrape_timeout: 30s
    honor_timestamps: true
    scheme: https
    authorization:
      type: Bearer
      credentials: '<API_KEY>'
    static_configs:
      - targets: ['metrics.temporal.io']
    metrics_path: '/v1/metrics'
  1. Import the Grafana dashboard and configure your Prometheus datasource.

OpenTelemetry Collector Configuration​

Collect metrics with a self-hosted OpenTelemetry Collector to ingest into the system of your choosing.

  1. Add a new prometheus receiver for the OpenMetrics endpoint with your API key.
receivers:
  prometheus:
    config:
      scrape_configs:
      - job_name: 'temporal-cloud'
        scrape_interval: 60s
        scrape_timeout: 30s
        honor_timestamps: true
        scheme: https
        authorization:
          type: Bearer
          credentials_file: <API_KEY_FILE>
        static_configs:
          - targets: ['metrics.temporal.io']
        metrics_path: '/v1/metrics'

processors:
  batch:

exporters:
  otlphttp:
    endpoint: <ENDPOINT>

service:
  pipelines:
    metrics:
      receivers: [prometheus]
      processors: [batch]
      exporters: [otlphttp]
info

Examples for these integrations and more are here.