Metrics

Some Arvados services publish Prometheus/OpenMetrics-compatible metrics at /metrics. Metrics can help you understand how components perform under load, find performance bottlenecks, and detect and diagnose problems.

To access metrics endpoints, services must be configured with a management token. When accessing a metrics endpoint, prefix the management token with "Bearer " and supply it in the Authorization request header.

curl -sfH "Authorization: Bearer your_management_token_goes_here" "https://0.0.0.0:25107/metrics"

The plain text export format includes “help” messages with a description of each reported metric.

When configuring Prometheus, use a bearer_token or bearer_token_file option to authenticate requests.

scrape_configs:
  - job_name: keepstore
    bearer_token: your_management_token_goes_here
    static_configs:
    - targets:
      - "keep0.ClusterID.example.com:25107"
Component Metrics endpoint
arvados-api-server
arvados-controller
arvados-dispatch-cloud
arvados-dispatch-lsf
arvados-ws
keepproxy
keepstore
keep-balance
keep-web
workbench2

Previous: Logging Next: Health checks

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.