[ARVADOS] created: 1.1.4-785-g3452443e1

[Git user]

        at  3452443e10152819757236cea1906149ee82fa3d (commit)


commit 3452443e10152819757236cea1906149ee82fa3d
Author: Tom Clegg <tclegg at veritasgenetics.com>
Date:   Tue Aug 14 17:22:26 2018 -0400

    13198: Note keep-web metrics in admin docs.
    
    Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tclegg at veritasgenetics.com>

diff --git a/doc/admin/metrics.html.textile.liquid b/doc/admin/metrics.html.textile.liquid
index e41a96ffc..55393748d 100644
--- a/doc/admin/metrics.html.textile.liquid
+++ b/doc/admin/metrics.html.textile.liquid
@@ -10,12 +10,34 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
-Metrics endpoints are found at @/status.json@ on many Arvados services.  The purpose of metrics are to provide statistics about the operation of a service, suitable for diagnosing how well a service is performing under load.
+Some Arvados services publish Prometheus/OpenMetrics-compatible metrics at @/metrics@, and some provide additional runtime status at @/status.json at .  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 .
+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/status.json"
+</pre>
+
+h2. Keep-web
+
+Keep-web exports metrics at @/metrics@ -- e.g., @https://collections.zzzzz.arvadosapi.com/metrics@.
+
+ at request_duration_seconds@ (summary, segmented by HTTP request method and response status code) measures the total elapsed time for each incoming request.
+
+ at time_to_status_seconds@ (summary, segmented by HTTP request method and response status code) measures the elapsed time between receiving a request and sending the HTTP response status code.
+
+Metrics in the @arvados_keepweb_collectioncache@ namespace report keep-web's internal cache of Arvados collection metadata:
+* @arvados_keepweb_collectioncache_requests@ counts cache lookups.
+* @arvados_keepweb_collectioncache_api_calls@ counts outgoing API calls.
+* @arvados_keepweb_collectioncache_cached_manifests@ indicates how many collections are in the cache.
+* @arvados_keepweb_collectioncache_cached_manifest_bytes@ indicates how much memory is consumed by cached collection manifests.
+* @arvados_keepweb_collectioncache_permission_hits@ counts collection-to-permission cache hits.
+* @arvados_keepweb_collectioncache_pdh_hits@ counts UUID-to-PDH cache hits.
+* @arvados_keepweb_collectioncache_hits@ counts PDH-to-manifest cache hits.
 
 h2. Keepstore
 
+Keepstore exports metrics at @/status.json@ -- e.g., @http://keep0.zzzzz.arvadosapi.com:25107/status.json@.
+
 h3. Root
 
 table(table table-bordered table-condensed).

-----------------------------------------------------------------------


hooks/post-receive
--