From 6419153c0bcddb570a608267747f1774e4633660 Mon Sep 17 00:00:00 2001 From: Julius Volz Date: Sun, 15 Mar 2015 02:59:03 +0100 Subject: [PATCH] Add Prometheus documentation. --- README.md | 2 ++ docs/prometheus.md | 5 +++++ 2 files changed, 7 insertions(+) create mode 100644 docs/prometheus.md diff --git a/README.md b/README.md index e92750ee..c01b0c8b 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ See the more detailed instructions in the [build page](docs/build.md). This incl cAdvisor supports exporting stats to [InfluxDB](http://influxdb.com). See the [documentation](docs/influxdb.md) for more information and examples. +cAdvisor also exposes container stats as [Prometheus](http://prometheus.io) metrics. See the [documentation](docs/prometheus.md) for more information. + [Heapster](https://github.com/GoogleCloudPlatform/heapster) enables cluster wide monitoring of containers using cAdvisor. ## Web UI diff --git a/docs/prometheus.md b/docs/prometheus.md new file mode 100644 index 00000000..c8ec0ff4 --- /dev/null +++ b/docs/prometheus.md @@ -0,0 +1,5 @@ +# Monitoring cAdvisor with Prometheus + +cAdvisor exposes container statistics as [Prometheus](http://prometheus.io) metrics out of the box. By default, these metrics are served under the `/metrics` HTTP endpoint. This endpoint may be customized by setting the `-prometheus_endpoint` command-line flag. + +To monitor cAdvisor with Prometheus, simply configure one or more jobs in Prometheus which scrape the relevant cAdvisor processes at that metrics endpoint. For details, see Prometheus's [Configuration](http://prometheus.io/docs/operating/configuration/) documentation, as well as the [Getting started](http://prometheus.io/docs/introduction/getting_started/) guide.