---
layout: default
navsection: admin
title: Metrics
...

{% comment %}
Copyright (C) The Arvados Authors. All rights reserved.

SPDX-License-Identifier: CC-BY-SA-3.0
{% endcomment %}

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":management-token.html. When accessing a metrics endpoint, prefix the management token with @"Bearer "@ and supply it in the @Authorization@ request header.

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

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.

<pre>scrape_configs:
  - job_name: keepstore
    bearer_token: your_management_token_goes_here
    static_configs:
    - targets:
      - "keep0.ClusterID.example.com:25107"
</pre>

table(table table-bordered table-condensed table-hover).
|_. Component|_. Metrics endpoint|
|arvados-api-server|✓|
|arvados-controller|✓|
|arvados-dispatch-cloud|✓|
|arvados-dispatch-lsf|✓|
|arvados-git-httpd||
|arvados-ws|✓|
|composer||
|keepproxy|✓|
|keepstore|✓|
|keep-balance|✓|
|keep-web|✓|
|workbench1||
|workbench2||