Document use-case without any StatsD server.

Fixes https://github.com/prometheus/statsd_bridge/issues/15
This commit is contained in:
Julius Volz 2015-06-18 14:23:23 +02:00
parent ce864c0131
commit 143288bf07

View file

@ -5,6 +5,8 @@ StatsD-Bridge receives StatsD-style metrics and exports them as Prometheus metri
## Overview
### With StatsD
To pipe metrics from an existing StatsD environment into Prometheus, configure
StatsD's repeater backend to repeat all received packets to a StatsD-Bridge
process. This bridge translates StatsD metrics to Prometheus metrics via
@ -14,6 +16,16 @@ configured mapping rules.
| StatsD |---(UDP repeater)--->| StatsD-Bridge |<---(scrape /metrics)---| Prometheus |
+----------+ +-----------------+ +--------------+
### Without StatsD
Since the StatsD bridge uses the same UDP protocol as StatsD itself, you can
also configure your applications to send StatsD metrics directly to the bridge.
In that case, you don't need to run a StatsD server anymore.
We recommend this only as an intermediate solution and recommend switching to
[native Prometheus instrumentation](http://prometheus.io/docs/instrumenting/clientlibs/)
in the long term.
## Building and Running
$ go build