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, i.e. metrics information is stored with the timestamp at which it was recorded, alongside optional key-value pairs called labels. Prometheus has been adopted by many companies as part of their observability stack.

This document will walk through how to set up a Prometheus integration with DeltaStream's metrics. The DeltaStream metrics that are exposed can be found in this doc. We will be using Grafana screenshots as the example of how to add the Prometheus Integration. NOTE: The metrics endpoint DeltaStream provides can only be scraped 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 DeltaStreams 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>"

...