How to set up Digibee API metrics with Prometheus

Learn how to integrate API metrics.

Prometheus is a monitoring platform that provides comprehensive insight into the performance and health of various aspects of an organization’s IT infrastructure, applications, and services.

Requirements

  • The feature must be enabled for your realm.

  • Username, Password and API Key generated on the Digibee APIs menu.

  • Connection between your Prometheus and the Digibee Integration Platform cluster.

Example of usage

Configuration

In your Prometheus job configuration file, add a job configuration as demonstrated below:

...
scrape_configs:
...
- job_name: digibee_platform_<ENVIRONMENT>
  scheme: https
  targets:
    - <DIGIBEE_SERVICES_API_URL>
  metrics_path: /metrics/openmetrics_raw?environment=<ENVIRONMENT>
  params:
    environment:
      - <ENVIRONMENT>
    apikey:
      - {DIGIBEE_SERVICES_API_APIKEY}
    metric:
      - <METRIC_NAME>

  basic_auth:
    username: <DIGIBEE_SERVICES_API_USERNAME>
    password: <DIGIBEE_SERVICES_API_PASSWORD>
  honor_timestamps: true
  scrape_interval: 5m
  scrape_timeout: 60s
  follow_redirects: true

Add your username using the format: <realm>-<username>, as shown in Digibee APIs.

Variables

Visualizing your data in Prometheus with Grafana

Last updated