statsd

README

A buffered statsd reporter

See examples/statsd_main.go for an end to end example.

Some emitted stats using the example listening with nc 8125 -l -u:

stats.my-service.test-histogram.100ms-200ms:2|c
stats.my-service.test-histogram.300ms-400ms:1|c
stats.my-service.test-histogram.600ms-800ms:1|c
stats.my-service.test-counter:1|c
stats.my-service.test-gauge:813|g

Options

You can use either a basic or a buffered statsd client and pass it to the reporter along with options.

The reporter options are:

// Options is a set of options for the tally reporter.
type Options struct {
	// SampleRate is the metrics emission sample rate. If you
	// do not set this value it will be set to 1.
	SampleRate float32
}

Documentation

Index

• Constants
• func NewReporter(statsd statsd.Statter, opts Options) tally.StatsReporter
• type Options

Constants

const (
	// DefaultHistogramBucketNamePrecision is the default
	// precision to use when formatting the metric name
	// with the histogram bucket bound values.
	DefaultHistogramBucketNamePrecision = uint(6)
)

Functions

func NewReporter

func NewReporter(statsd statsd.Statter, opts Options) tally.StatsReporter

NewReporter wraps a statsd.Statter for use with tally. Use either statsd.NewClient or statsd.NewBufferedClient.

Types

type Options

type Options struct {
	// SampleRate is the metrics emission sample rate. If you
	// do not set this value it will be set to 1.
	SampleRate float32

	// HistogramBucketNamePrecision is the precision to use when
	// formatting the metric name with the histogram bucket bound values.
	// By default this will be set to the const DefaultHistogramBucketPrecision.
	HistogramBucketNamePrecision uint
}

Options is a set of options for the tally reporter.