luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity
open-vault/website/content/api-docs/system/metrics.mdx

70 lines
2.3 KiB
Plaintext
Raw Normal View History

Add Docs For Prometheus Metrics (#6434) Prometheus metrics were added as part of the Vault v1.1.0 release in PR #5308. But no documentation was created. Adds the telemetry configuration docs and the API docs.
2019-03-23 21:53:43 +00:00
---
New Website! (#8154) * new documentation website * ci job adjustment * update to latest version on downloads page * remove transition-period scripts * add netlify toml file * fix docs patch * fix ci config? * revert go.mod changes * a couple last markdown formatting fixes
2020-01-18 00:18:09 +00:00
layout: api
page_title: /sys/metrics - HTTP API
sidebar_title: <code>/sys/metrics</code>
description: The `/sys/metrics` endpoint is used to get telemetry metrics for Vault.
Add Docs For Prometheus Metrics (#6434) Prometheus metrics were added as part of the Vault v1.1.0 release in PR #5308. But no documentation was created. Adds the telemetry configuration docs and the API docs.
2019-03-23 21:53:43 +00:00
---
# `/sys/metrics`
The `/sys/metrics` endpoint is used to get telemetry metrics for Vault.
## Read Telemetry Metrics
This endpoint returns the telemetry metrics for Vault. It can be used by metrics
collections systems like [Prometheus](https://prometheus.io) that use a pull
model for metrics collection.
New Website! (#8154) * new documentation website * ci job adjustment * update to latest version on downloads page * remove transition-period scripts * add netlify toml file * fix docs patch * fix ci config? * revert go.mod changes * a couple last markdown formatting fixes
2020-01-18 00:18:09 +00:00
| Method | Path |
| :----- | :------------- |
| `GET` | `/sys/metrics` |
Add Docs For Prometheus Metrics (#6434) Prometheus metrics were added as part of the Vault v1.1.0 release in PR #5308. But no documentation was created. Adds the telemetry configuration docs and the API docs.
2019-03-23 21:53:43 +00:00
### Parameters
- `format` `(string: "")` – Specifies the format used for the returned metrics. The
default metrics format is JSON. Setting `format` to `prometheus` will return the
metrics in [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format).
Update sample request (#7431) - Format curl command to be similar to other sample requests - Add single quotes to URL for '?' so that example is functional - Delete trailing space
2019-09-25 20:32:42 +00:00
Add Docs For Prometheus Metrics (#6434) Prometheus metrics were added as part of the Vault v1.1.0 release in PR #5308. But no documentation was created. Adds the telemetry configuration docs and the API docs.
2019-03-23 21:53:43 +00:00
### Sample Request
🌷 Docs Website Maintenance (#8985) * website maintenance round * improve docs, revert bug workaround as it was fixed * boost memory * remove unnecessary code
2020-05-21 17:18:17 +00:00
```shell-session
Update sample request (#7431) - Format curl command to be similar to other sample requests - Add single quotes to URL for '?' so that example is functional - Delete trailing space
2019-09-25 20:32:42 +00:00
$ curl \
--header "X-Vault-Token: ..." \
'http://127.0.0.1:8200/v1/sys/metrics?format=prometheus'
Add Docs For Prometheus Metrics (#6434) Prometheus metrics were added as part of the Vault v1.1.0 release in PR #5308. But no documentation was created. Adds the telemetry configuration docs and the API docs.
2019-03-23 21:53:43 +00:00
```
### Sample Response
This response is only returned for a `GET` request.
```
# HELP vault_audit_log_request vault_audit_log_request
# TYPE vault_audit_log_request summary
vault_audit_log_request{quantile="0.5"} 0.005927000194787979
vault_audit_log_request{quantile="0.9"} 0.005927000194787979
vault_audit_log_request{quantile="0.99"} 0.005927000194787979
vault_audit_log_request_sum 0.014550999738276005
vault_audit_log_request_count 2
# HELP vault_audit_log_request_failure vault_audit_log_request_failure
# TYPE vault_audit_log_request_failure counter
vault_audit_log_request_failure 0
# HELP vault_audit_log_response vault_audit_log_response
# TYPE vault_audit_log_response summary
vault_audit_log_response{quantile="0.5"} NaN
vault_audit_log_response{quantile="0.9"} NaN
vault_audit_log_response{quantile="0.99"} NaN
vault_audit_log_response_sum 0.0057669999077916145
vault_audit_log_response_count 1
# HELP vault_audit_log_response_failure vault_audit_log_response_failure
# TYPE vault_audit_log_response_failure counter
vault_audit_log_response_failure 0
# HELP vault_barrier_get vault_barrier_get
# TYPE vault_barrier_get summary
vault_barrier_get{quantile="0.5"} 0.011938000097870827
vault_barrier_get{quantile="0.9"} 0.011938000097870827
vault_barrier_get{quantile="0.99"} 0.011938000097870827
vault_barrier_get_sum 0.1814980012131855
vault_barrier_get_count 36
Update sample request (#7431) - Format curl command to be similar to other sample requests - Add single quotes to URL for '?' so that example is functional - Delete trailing space
2019-09-25 20:32:42 +00:00
...
Add Docs For Prometheus Metrics (#6434) Prometheus metrics were added as part of the Vault v1.1.0 release in PR #5308. But no documentation was created. Adds the telemetry configuration docs and the API docs.
2019-03-23 21:53:43 +00:00
```