status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add docs for MIME sniffing on metrics endpoint. (#9696) 

* Add docs for MIME sniffing on metrics endpoint.

This was added in 1.7.2 last year but I realised we don't document it so it's kinda surprising Prometheus "just works" now.

* Update website/content/api-docs/agent/index.mdx
This commit is contained in:
Paul Banks 2021-02-17 10:39:08 +00:00 committed by hashicorp-ci
parent 5a8fc428bd
commit 4b5f34e49a
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
website/content/api-docs/agent/index.mdx
View File

@ -246,10 +246,19 @@ In order to enable [Prometheus](https://prometheus.io/) support, you need to use
configuration directive configuration directive
[`prometheus_retention_time`](/docs/agent/options#telemetry-prometheus_retention_time). [`prometheus_retention_time`](/docs/agent/options#telemetry-prometheus_retention_time).
Note: If your metric includes labels that use the same key name multiple times Since Consul 1.7.2 this endpoint will also automatically switch output format if
(i.e. tag=tag2 and tag=tag1), only the sorted last value (tag=tag2) will be visible on the request contains an `Accept` header with a compatible MIME type such as
this endpoint due to a display issue. The complete label set is correctly applied and `application/openmetrics-text`. Prometheus v2.5.0 and newer pass this header in scraping
passed to external metrics providers even though it is not visible through this endpoint. queries, and so will get a compatible format by default. Older versions of Prometheus may
work by default as several previously used MIME types are also detected, but the `?format`
query parameter may also be used to specify the output format manually if needed.
simplifying scrape configuration.
Note: If using the default format and your metric includes labels that use the same key
name multiple times (i.e. tag=tag2 and tag=tag1), only the sorted last value (tag=tag2)
will be visible on this endpoint due to a display issue. The complete label set is correctly
applied and passed to external metrics providers even though it is not visible through this
endpoint.
| Method | Path | Produces | | Method | Path | Produces |
| ------ | ---------------------------------- | ------------------------------------------ | | ------ | ---------------------------------- | ------------------------------------------ |