From 9b8e12f636d444ac7a4068b18939394ff170d97a Mon Sep 17 00:00:00 2001 From: Sean Porter Date: Mon, 2 Oct 2017 22:46:00 -0700 Subject: [PATCH] readme, configuration examples --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e7ca7cd..fb664dc 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,47 @@ Influx (the default), Graphite, or JSON. The Sensu Prometheus Collector turns Sensu into a *SUPER POWERED Prometheus metric poller*, leveraging Sensu's pubsub design and client -auto-registration (discovery). Sensu can deliver metrics to one or -more time-series databases, for example InfluxDB or Graphite! -Instrument your applications with the Prometheus clients and -immediately begin collecting your metrics with Sensu! +auto-registration (discovery). Sensu can deliver collected metrics to +one or more time-series databases, for example InfluxDB and/or +Graphite! Instrument your applications with the Prometheus libraries +and immediately begin collecting your metrics with Sensu! -### Examples +### Configuration + +Example Sensu 1.x check definition: + +```json +{ + "checks": { + "prometheus_metrics": { + "type": "metric", + "command": "sensu-prometheus-collector -exporter-url http://localhost:8080/metrics", + "subscribers": ["app_tier"], + "interval": 10, + "handler": "influx" + } + } +} +``` + +Example Sensu 1.x handler definition: + +```json +{ + "handlers": { + "influx": { + "type": "udp", + "mutator": "only_check_output", + "socket": { + "host": "influx.example.com", + "port": 8189 + } + } + } +} +``` + +### Usage Examples Help: