From a390d2ef0cc5757198b2f81424d0b657798711f3 Mon Sep 17 00:00:00 2001 From: Xander Grzywinski Date: Fri, 27 Jul 2018 12:57:48 -0700 Subject: [PATCH] statsd docs (Issue #2002) (#2005) * statsd documentation --- docs/storage/README.md | 2 +- docs/storage/statsd.md | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 docs/storage/statsd.md diff --git a/docs/storage/README.md b/docs/storage/README.md index a3cd0246..a649bbce 100644 --- a/docs/storage/README.md +++ b/docs/storage/README.md @@ -10,5 +10,5 @@ cAdvisor supports exporting stats to various storage driver plugins. To enable a - [Kafka](http://kafka.apache.org/). See the [documentation](kafka.md) for usage. - [Prometheus](https://prometheus.io). See the [documentation](prometheus.md) for usage and examples. - [Redis](http://redis.io/) -- [StatsD](https://github.com/etsy/statsd) +- [StatsD](https://github.com/etsy/statsd). See the [documentation](statsd.md) for usage and examples. - `stdout` - write stats to standard output. diff --git a/docs/storage/statsd.md b/docs/storage/statsd.md new file mode 100644 index 00000000..b1ca57c1 --- /dev/null +++ b/docs/storage/statsd.md @@ -0,0 +1,26 @@ +# Exporting cAdvisor Stats to statsd + +cAdvisor supports exporting stats to [statsd](https://github.com/etsy/statsd). To use statsd, you need to pass some additional flags to cAdvisor telling it where to find statsd: + +Set the storage driver as statsd. + +``` + -storage_driver=statsd +``` + +Specify what statsd instance to push data to: + +``` + # The *ip:port* of the instance. Default is 'localhost:8086' + -storage_driver_host=ip:port +``` + +# Examples + +The easiest way to get up an running is to start the cadvisor binary with the `--storage_driver` and `--storage_driver_host` flags. + +``` +cadvisor --storage_driver="statsd" --storage_driver_host="localhost:8125" +``` + +The default port for statsd is 8125, so this wil start pumping metrics directly to it. \ No newline at end of file