Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 1.52 KB

CONFIGURING_METRICS.md

File metadata and controls

46 lines (37 loc) · 1.52 KB

OpenTelemetry Metrics

Application-level metrics from Janus components can be exported to one of the following services.

Prometheus

When the Prometheus exporter is enabled, a server will listen on port 9464 for metrics scrape requests. Prometheus must be configured to scrape the server, either manually or via an auto-discovery mechanism. Compile janus_aggregator with the prometheus feature enabled, and add the following to the configuration file.

metrics_config:
  exporter:
    prometheus:
      host: 0.0.0.0
      port: 9464

The IP address and port that Prometheus exporter listens on can optionally be set in the configuration file as above. If the host and port are not set, it will fall back to the environment variables OTEL_EXPORTER_PROMETHEUS_HOST and OTEL_EXPORTER_PROMETHEUS_PORT, or the default values of 0.0.0.0 and 9464.

Honeycomb

Honeycomb also supports OpenTelemetry-formatted metrics, though only on the Enterprise and Pro plans. Compile janus_aggregator with the otlp feature enabled, and add the following section to the configuration file. Note that the OTLP/gRPC exporter will push metrics at regular intervals.

metrics_config:
  exporter:
    otlp:
      endpoint: "https://api.honeycomb.io:443"
      metadata:
        x-honeycomb-team: "YOUR_API_KEY"
        x-honeycomb-dataset: "YOUR_METRICS_DATASET"

The command line flag --otlp-metrics-metadata or environment variable OTLP_METRICS_METADATA may alternately be used to supply gRPC metadata for the metrics exporter.