arangodb/Documentation/DocuBlocks/Rest/Administration/get_admin_metrics.md

@startDocuBlock get_admin_metrics @brief return the current instance metrics

@RESTHEADER{GET /_admin/metrics, Read the metrics, getMetrics}

@RESTDESCRIPTION Returns the instance's current metrics in Prometheus format. The returned document collects all instance metrics, which are measured at any given time and exposes them for collection by Prometheus.

The document contains different metrics and metrics groups dependent on the role of the queried instance. All exported metrics are published with the arangodb_ or rocksdb_ string to distinguish them from other collected data.

The API then needs to be added to the Prometheus configuration file for collection.

@RESTRETURNCODES

@RESTRETURNCODE{200} Metrics were returned successfully.

@RESTRETURNCODE{404} The metrics API may be disabled using --server.export-metrics-api false setting in the server. In this case, the result of the call indicates the API to be not found.

@endDocuBlock