doc/admin/metrics.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: Metrics
   5 ...
   6
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 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.
  14
  15 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.
  16
  17 <pre>curl -sfH "Authorization: Bearer your_management_token_goes_here" "https://0.0.0.0:25107/metrics"
  18 </pre>
  19
  20 The plain text export format includes "help" messages with a description of each reported metric.
  21
  22 When configuring Prometheus, use a @bearer_token@ or @bearer_token_file@ option to authenticate requests.
  23
  24 <pre>scrape_configs:
  25   - job_name: keepstore
  26     bearer_token: your_management_token_goes_here
  27     static_configs:
  28     - targets:
  29       - "keep0.ClusterID.example.com:25107"
  30 </pre>
  31
  32 table(table table-bordered table-condensed table-hover).
  33 |_. Component|_. Metrics endpoint|
  34 |arvados-api-server||
  35 |arvados-controller|✓|
  36 |arvados-dispatch-cloud|✓|
  37 |arvados-git-httpd||
  38 |arvados-ws|✓|
  39 |composer||
  40 |keepproxy||
  41 |keepstore|✓|
  42 |keep-balance|✓|
  43 |keep-web|✓|
  44 |workbench1||
  45 |workbench2||