From 84be97bd98e4801c48b96c3e1baba9e8c7e891c1 Mon Sep 17 00:00:00 2001 From: Brian Brazil Date: Mon, 17 Jul 2017 14:20:54 +0100 Subject: [PATCH] Tweaks to SD README from review --- discovery/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/discovery/README.md b/discovery/README.md index 3d98e2033..0dbe95040 100644 --- a/discovery/README.md +++ b/discovery/README.md @@ -47,10 +47,12 @@ file for use with `file_sd`. The general principle with SD is to extract all the potentially useful information we can out of the SD, and let the user choose what they need of it -using relabelling. This information is generally termed metadata. +using +[relabelling](https://prometheus.io/docs/operating/configuration/#). +This information is generally termed metadata. Metadata is exposed as a set of key/value pairs (labels) per target. The keys -are prefixed with `__meta_sdname_`, and there should also be an `__address__` +are prefixed with `__meta__`, and there should also be an `__address__` label with the host:port of the target (preferably an IP address to avoid DNS lookups). No other labelnames should be exposed. @@ -79,7 +81,7 @@ combined. For machine-like SDs (OpenStack, EC2, Kubernetes to some extent) there may be multiple network interfaces for a target. Thus far reporting the details -of only the first network interface has sufficed. +of only the first/primary network interface has sufficed. ### Other implementation considerations