From 143288bf07847a89ff4c48d6ccc629d4eb85337a Mon Sep 17 00:00:00 2001 From: Julius Volz Date: Thu, 18 Jun 2015 14:23:23 +0200 Subject: [PATCH] Document use-case without any StatsD server. Fixes https://github.com/prometheus/statsd_bridge/issues/15 --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index c8db563..2bc7843 100644 --- a/README.md +++ b/README.md @@ -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