diff options
Diffstat (limited to 'backends/prometheus/README.md')
| -rw-r--r-- | backends/prometheus/README.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/backends/prometheus/README.md b/backends/prometheus/README.md index e234efe94..10275fa20 100644 --- a/backends/prometheus/README.md +++ b/backends/prometheus/README.md @@ -1,3 +1,8 @@ +<!-- +title: "Using Netdata with Prometheus" +custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/prometheus/README.md +--> + # Using Netdata with Prometheus > IMPORTANT: the format Netdata sends metrics to prometheus has changed since Netdata v1.7. The new prometheus backend @@ -12,7 +17,7 @@ are starting at a fresh ubuntu shell (whether you'd like to follow along in a VM ### Installing Netdata -There are number of ways to install Netdata according to [Installation](../../packaging/installer/). The suggested way +There are number of ways to install Netdata according to [Installation](/packaging/installer/README.md). The suggested way of installing the latest Netdata and keep it upgrade automatically. Using one line installation: ```sh @@ -349,7 +354,7 @@ For more information check prometheus documentation. ### Streaming data from upstream hosts -The `format=prometheus` parameter only exports the host's Netdata metrics. If you are using the master/slave +The `format=prometheus` parameter only exports the host's Netdata metrics. If you are using the parent-child functionality of Netdata this ignores any upstream hosts - so you should consider using the below in your **prometheus.yml**: @@ -381,6 +386,8 @@ To save bandwidth, and because prometheus does not use them anyway, `# TYPE` and wanted they can be re-enabled via `types=yes` and `help=yes`, e.g. `/api/v1/allmetrics?format=prometheus&types=yes&help=yes` +Note that if enabled, the `# TYPE` and `# HELP` lines are repeated for every occurrence of a metric, which goes against the Prometheus documentation's [specification for these lines](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#comments-help-text-and-type-information). + ### Names and IDs Netdata supports names and IDs for charts and dimensions. Usually IDs are unique identifiers as read by the system and |