opentelemetry-js/experimental/examples/prometheus

Overview

OpenTelemetry metrics allow a user to collect data and export it to a metrics backend like Prometheus.

This is a simple example that demonstrates basic metrics collection and exports those metrics to a Prometheus compatible endpoint.

Installation

# from this directory
npm install

Run the Application

# from this directory
npm run start

If you are using the default configurations, the metrics should be available at http://localhost:9464/metrics

Run Prometheus

With docker

# from this directory
docker compose up

With binary

Setup Prometheus

• Replace the prometheus.yml provided by the Prometheus installation with the following:

global:
  scrape_interval: 15s # Default is every 1 minute.

scrape_configs:
  - job_name: 'opentelemetry'
    # metrics_path defaults to '/metrics'
    # scheme defaults to 'http'.
    static_configs:
    - targets: ['localhost:9464']

• Start Prometheus

# from the directory you downloaded prometheus
prometheus --config.file=prometheus.yml

Prometheus UI

If you are using the default configurations, the prometheus client will be available at http://localhost:9090

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more information on OpenTelemetry metrics, visit: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/sdk-metrics
• For more information on OpenTelemetry for Node.js, visit: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node

LICENSE

Apache License 2.0