From a92834c8af2d3dc39c88f3ce896dc2eb54f8f549 Mon Sep 17 00:00:00 2001 From: "Tim St. Clair" Date: Wed, 4 May 2016 19:41:07 -0700 Subject: [PATCH] Cleanup cAdvisor storage docs --- README.md | 10 ++-------- docs/storage/README.md | 14 ++++++++++++++ docs/{ => storage}/elasticsearch.md | 0 docs/{ => storage}/influxdb.md | 0 docs/{ => storage}/prometheus.md | 0 5 files changed, 16 insertions(+), 8 deletions(-) create mode 100644 docs/storage/README.md rename docs/{ => storage}/elasticsearch.md (100%) rename docs/{ => storage}/influxdb.md (100%) rename docs/{ => storage}/prometheus.md (100%) diff --git a/README.md b/README.md index 2b1555c2..dc4b9c91 100644 --- a/README.md +++ b/README.md @@ -32,15 +32,9 @@ We have detailed [instructions](docs/running.md#standalone) on running cAdvisor See the more detailed instructions in the [build page](docs/development/build.md). This includes instructions for building and deploying the cAdvisor Docker image. -## InfluxDB and Cluster Monitoring +## Exporting stats -cAdvisor supports exporting stats to [InfluxDB](https://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. - -cAdvisor also supports exporting stats to [ElasticSearch](https://www.elastic.co/). See the [documentation](docs/elasticsearch.md) for more information. - -[Heapster](https://github.com/kubernetes/heapster) enables cluster wide monitoring of containers using cAdvisor. +cAdvisor supports exporting stats to various storage plugins. See the [documentation](docs/storage/README.md) for more details and examples. ## Web UI diff --git a/docs/storage/README.md b/docs/storage/README.md new file mode 100644 index 00000000..f3c05737 --- /dev/null +++ b/docs/storage/README.md @@ -0,0 +1,14 @@ +# cAdvisor Storage Plugins + +cAdvisor supports exporting stats to various storage driver plugins. To enable a storage driver, set the `-storage_driver` flag. + +## Storage drivers + +- [BigQuery](https://cloud.google.com/bigquery/). See the [documentation](../../storage/bigquery/README.md) for usage. +- [ElasticSearch](https://www.elastic.co/). See the [documentation](elasticsearch.md) for usage and examples. +- [InfluxDB](https://influxdb.com/). See the [documentation](influxdb.md) for usage and examples. +- [Kafka](http://kafka.apache.org/) +- [Prometheus](http://prometheus.io). See the [documentation](prometheus.md) for usage and examples. +- [Redis](http://redis.io/) +- [StatsD](https://github.com/etsy/statsd) +- `stdout` - write stats to standard output. diff --git a/docs/elasticsearch.md b/docs/storage/elasticsearch.md similarity index 100% rename from docs/elasticsearch.md rename to docs/storage/elasticsearch.md diff --git a/docs/influxdb.md b/docs/storage/influxdb.md similarity index 100% rename from docs/influxdb.md rename to docs/storage/influxdb.md diff --git a/docs/prometheus.md b/docs/storage/prometheus.md similarity index 100% rename from docs/prometheus.md rename to docs/storage/prometheus.md