From 7ffd96f4254cdabacea656aefb01f20755ae8b09 Mon Sep 17 00:00:00 2001 From: Mathias Methner Date: Thu, 1 Dec 2016 16:59:35 +0100 Subject: [PATCH] Document how to publish prometheus metric endpoint on all interfaces This is a combination of 4 commits. The first commit's message is: 2677 docu, how to publish prometheus metric endpoint on all interfaces This is the 2nd commit message: 2677 change docu on how to publish metrics, be more careful with publishing on all interfaces This is the 3rd commit message: 2677 fix spelling This is the 4th commit message: 2677 fix wrong port title and grammar --- site/metrics.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/site/metrics.md b/site/metrics.md index 6d1acb1576..068eb953e8 100644 --- a/site/metrics.md +++ b/site/metrics.md @@ -20,6 +20,19 @@ exposed: * `weave_dns_entries` - Number of DNS entries. * `weave_flows` - Number of FastDP flows. +#### Publish Router Metrics Endpoint + +By default, when started via `weave launch`, weave listens on its local +interface to serve metrics. To publish your metrics throughout your cluster, +e.g. if your prometheus server is installed on a different host machine, +you need to set `WEAVE_STATUS_ADDR` to your corresponding IP and port. +Default port is 6782. + +`WEAVE_STATUS_ADDR=X.X.X.X:PORT` + +You can set `WEAVE_STATUS_ADDR=0.0.0.0:6782` to listen on all interfaces, +but be aware, this may expose your metrics to the public internet. + ### Kubernetes Network Policy Controller Metrics The endpoint address is `localhost:6781`; the following metric is