diff options
| author | Frank Ch. Eigler <fche@redhat.com> | 2019-11-07 04:00:16 -0500 |
|---|---|---|
| committer | Mark Wielaard <mark@klomp.org> | 2019-11-23 00:31:26 +0100 |
| commit | 8d5a05a7f006968653f813529be1df253a881040 (patch) | |
| tree | 1ea5957305aa8116e39cdbc8f8e0e83e2ad31274 /doc | |
| parent | 0587c28365ccb119f860c1b3ca115a6105baadc8 (diff) | |
| download | elfutils-8d5a05a7f006968653f813529be1df253a881040.tar.gz | |
debuginfod 5: add /metrics endpoint
This webapi extensions allows admins to hook up debuginfod to a
prometheus-compatible monitoring system for general situational
statistics. The metrics are simple enough that local curl requests
can give a user a sense of what's going on. The metrics are
documented as unstable with respect to future versions.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/debuginfod.8 | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/debuginfod.8 b/doc/debuginfod.8 index 8783df58..210550e8 100644 --- a/doc/debuginfod.8 +++ b/doc/debuginfod.8 @@ -176,7 +176,7 @@ May be repeated to increase details. The default verbosity is 0. .\" Much of the following text is duplicated with debuginfod-find.1 -The debuginfod's webapi resembles ordinary file service, where a GET +debuginfod's webapi resembles ordinary file service, where a GET request with a path containing a known buildid results in a file. Unknown buildid / request combinations result in HTTP error codes. This file service resemblance is intentional, so that an installation @@ -239,6 +239,14 @@ l l. \../bar/foo.c AT_comp_dir=/zoo/ /buildid/BUILDID/source/zoo//../bar/foo.c .TE +.SS /metrics + +This endpoint returns a Prometheus formatted text/plain dump of a +variety of statistics about the operation of the debuginfod server. +The exact set of metrics and their meanings may change in future +versions. Caution: configuration information (path names, versions) +may be disclosed. + .SH DATA MANAGEMENT debuginfod stores its index in an sqlite database in a densely packed @@ -325,7 +333,8 @@ a denial-of-service in terms of RAM, CPU, disk I/O, or network I/O. If this is a problem, users are advised to install debuginfod with a HTTPS reverse-proxy front-end that enforces site policies for firewalling, authentication, integrity, authorization, and load -control. +control. The \fI/metrics\fP webapi endpoint is probably not +appropriate for disclosure to the public. When relaying queries to upstream debuginfods, debuginfod \fBdoes not\fP include any particular security features. It trusts that the binaries |