StatsD to Prometheus metrics exporter
Find a file
Ben Kochie 6a84b510c6 Release 0.2.0
* Update Makefile.
* Add CHANGELOG.md.
2016-03-20 10:52:31 +01:00
.gitignore Update build 2016-03-20 09:40:05 +01:00
AUTHORS.md Update Julius's email address in AUTHORS.md 2015-10-26 02:25:54 +01:00
bridge_test.go Fix license headers to match LICENSE file. 2015-02-19 01:04:25 +01:00
CHANGELOG.md Release 0.2.0 2016-03-20 10:52:31 +01:00
CONTRIBUTING.md License cleanup 2015-01-22 17:56:04 +01:00
Dockerfile New Dockerfile using alpine-golang-make-onbuild base image 2015-06-18 20:50:31 +02:00
exporter.go rename bridge -> exporter 2015-10-09 20:34:28 -04:00
LICENSE License cleanup 2015-01-22 17:56:04 +01:00
main.go Merge pull request #26 from macb/exporter_rename 2015-10-17 15:50:01 +02:00
Makefile Release 0.2.0 2016-03-20 10:52:31 +01:00
Makefile.COMMON Update build 2016-03-20 09:40:05 +01:00
mapper.go allow metrics with dashes when mapping 2015-10-09 19:38:21 -04:00
mapper_test.go allow metrics with dashes when mapping 2015-10-09 19:38:21 -04:00
NOTICE rename bridge -> exporter 2015-10-09 20:34:28 -04:00
README.md fix documentation for docker udp port publishing 2016-02-01 16:54:59 +01:00
telemetry.go rename bridge -> exporter 2015-10-09 20:34:28 -04:00

statsd_exporter

statsd_exporter receives StatsD-style metrics and exports them as Prometheus metrics.

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_exporter process. This exporter translates StatsD metrics to Prometheus metrics via configured mapping rules.

+----------+                     +-------------------+                        +--------------+
|  StatsD  |---(UDP repeater)--->|  statsd_exporter  |<---(scrape /metrics)---|  Prometheus  |
+----------+                     +-------------------+                        +--------------+

Without StatsD

Since the StatsD exporter uses the same UDP protocol as StatsD itself, you can also configure your applications to send StatsD metrics directly to the exporter. 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 in the long term.

Building and Running

$ go build
$ ./statsd_exporter --help
Usage of ./statsd_exporter:
  -statsd.listen-address=":9125": The UDP address on which to receive statsd metric lines.
  -statsd.mapping-config="": Metric mapping configuration file name.
  -web.listen-address=":9102": The address on which to expose the web interface and generated Prometheus metrics.
  -web.telemetry-path="/metrics": Path under which to expose metrics.

Tests

$ go test

Metric Mapping and Configuration

The statsd_exporter can be configured to translate specific dot-separated StatsD metrics into labeled Prometheus metrics via a simple mapping language. A mapping definition starts with a line matching the StatsD metric in question, with *s acting as wildcards for each dot-separated metric component. The lines following the matching expression must contain one label="value" pair each, and at least define the metric name (label name name). The Prometheus metric is then constructed from these labels. $n-style references in the label value are replaced by the n-th wildcard match in the matching line, starting at 1. Multiple matching definitions are separated by one or more empty lines. The first mapping rule that matches a StatsD metric wins.

Metrics that don't match any mapping in the configuration file are translated into Prometheus metrics without any labels and with certain characters escaped (_ -> __; - -> __; . -> _).

In general, the different metric types are translated as follows, with certain suffixes appended to the Prometheus metric names:

StatsD gauge   -> Prometheus gauge (suffix `_gauge`)

StatsD counter -> Prometheus counter (suffix `_counter`)

StatsD timer   -> Prometheus summary (suffix `_timer`)        <-- indicates timer quantiles
               -> Prometheus counter (suffix `_timer_total`)  <-- indicates total time spent
               -> Prometheus counter (suffix `_timer_count`)  <-- indicates total number of timer events

An example mapping configuration:

test.dispatcher.*.*.*
name="dispatcher_events"
processor="$1"
action="$2"
outcome="$3"
job="test_dispatcher"

*.signup.*.*
name="signup_events"
provider="$2"
outcome="$3"
job="${1}_server"

This would transform these example StatsD metrics into Prometheus metrics as follows:

test.dispatcher.FooProcessor.send.success (counter)
 => dispatcher_events_counter{processor="FooProcessor", action="send", outcome="success", job="test_dispatcher"}

foo_product.signup.facebook.failure (counter)
 => signup_events_counter{provider="facebook", outcome="failure", job="foo_product_server"}

test.web-server.foo.bar (gauge)
 => test_web__server_foo_bar_gauge{}

Using Docker

You can deploy this exporter using the prom/statsd-exporter Docker image.

For example:

docker pull prom/statsd-exporter

docker run -d -p 9102:9102 -p 9125:9125/udp \
        -v $PWD/statsd_mapping.conf:/tmp/statsd_mapping.conf \
        prom/statsd-exporter -statsd.mapping-config=/tmp/statsd_mapping.conf