Update README.md

This commit is contained in:
juliusv 2013-07-05 23:49:05 +02:00
parent fc78bc553d
commit a3dfea3958

View file

@ -1,7 +1,7 @@
StatsD-Bridge StatsD-Bridge
============= =============
StatsD-Bridge receives StatsD-style metrics and exporting them as Prometheus metrics. StatsD-Bridge receives StatsD-style metrics and exports them as Prometheus metrics.
## Overview ## Overview
@ -18,7 +18,7 @@ To pipe metrics from an existing StatsD environment into Prometheus, configure S
Usage of ./statsd_bridge: Usage of ./statsd_bridge:
-listeningAddress=":8080": The address on which to expose generated Prometheus metrics. -listeningAddress=":8080": The address on which to expose generated Prometheus metrics.
-mappingConfig="mapping.conf": Metric mapping configuration file name. -mappingConfig="mapping.conf": Metric mapping configuration file name.
-statsdListeningAddress=":8126": The UDP address on which to receive statsd metric lines. -statsdListeningAddress=":9125": The UDP address on which to receive statsd metric lines.
-summaryFlushInterval=15m0s: How frequently to reset all summary metrics. -summaryFlushInterval=15m0s: How frequently to reset all summary metrics.
## Tests ## Tests
@ -44,7 +44,7 @@ An example mapping configuration:
outcome="$3" outcome="$3"
job="$1_server" job="$1_server"
This would transform these example StatsD metrics as into Prometheus metrics as follows: This would transform these example StatsD metrics into Prometheus metrics as follows:
test.dispatcher.FooProcessor.send.success test.dispatcher.FooProcessor.send.success
=> dispatcher_events{processor="FooProcessor", action="send", outcome="success", job="test_dispatcher"} => dispatcher_events{processor="FooProcessor", action="send", outcome="success", job="test_dispatcher"}