Prometheus Integration

Add DeltaStream metrics endpoint as a Prometheus Metrics Endpoint

Prometheus is an open-source systems monitoring and alerting toolkit that collects and stores its metrics as time series data. In other words, it stores metrics information with the timestamp at which the data was recorded, alongside optional key-value pairs called labels. Many organizations have adopted Prometheus as part of their observability stack.

This document walks you through how to set up a Prometheus integration with DeltaStream's metrics. It includes the DeltaStream metrics that are exposed. We use Grafana screenshots as the example of how to add the Prometheus integration.

Note You can only scrape the DeltaStream metrics endpoint every 60 seconds.

Step 1: Create DeltaStream Metrics Token

https://docs.deltastream.io/reference/sql-syntax/ddl/create-metrics-integration

Step 2: Add new Prometheus Endpoint to Scrape DeltaStream Metrics

1. Add DeltaStream's metric endpoint generated from Step 1 as an additional scrape metric config in your Prometheus deployment.

- job_name: deltastream-metrics
  metrics_path: /metrics
  scheme: https
  scrape_interval: 60s
  scrape_protocols: [ "PrometheusText0.0.4" ]
  authorization:
    type: Bearer
    credentials: <your Bearer token from Step 1>
  static_configs:
    - targets:
      - "api-atyo2.deltastream.io" # [ your URI from Step 1 ]
      labels:
         <your custom label> : "<your custom label value>"