Documentation
¶
Overview ¶
Package influxstatsd provides support for InfluxData's StatsD Telegraf plugin. It's very similar to StatsD, but supports arbitrary tags per-metric, which map to Go kit's label values. So, while label values are no-ops in StatsD, they are supported here. For more details, see the article at https://www.influxdata.com/blog/getting-started-with-sending-statsd-metrics-to-telegraf-influxdb/
This package batches observations and emits them on some schedule to the remote server. This is useful even if you connect to your service over UDP. Emitting one network packet per observation can quickly overwhelm even the fastest internal network.
Index ¶
- type Counter
- type Gauge
- type Histogram
- type Influxstatsd
- func (d *Influxstatsd) NewCounter(name string, sampleRate float64) *Counter
- func (d *Influxstatsd) NewGauge(name string) *Gauge
- func (d *Influxstatsd) NewHistogram(name string, sampleRate float64) *Histogram
- func (d *Influxstatsd) NewTiming(name string, sampleRate float64) *Timing
- func (d *Influxstatsd) SendLoop(c <-chan time.Time, network, address string)
- func (d *Influxstatsd) WriteLoop(c <-chan time.Time, w io.Writer)
- func (d *Influxstatsd) WriteTo(w io.Writer) (count int64, err error)
- type Timing
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Counter ¶
type Counter struct {
// contains filtered or unexported fields
}
Counter is a InfluxStatsD counter. Observations are forwarded to a Influxstatsd object, and aggregated (summed) per timeseries.
type Gauge ¶
type Gauge struct {
// contains filtered or unexported fields
}
Gauge is a InfluxStatsD gauge. Observations are forwarded to a Influxstatsd object, and aggregated (the last observation selected) per timeseries.
type Histogram ¶
type Histogram struct {
// contains filtered or unexported fields
}
Histogram is a InfluxStatsD histrogram. Observations are forwarded to a Influxstatsd object, and collected (but not aggregated) per timeseries.
type Influxstatsd ¶
type Influxstatsd struct {
// contains filtered or unexported fields
}
Influxstatsd receives metrics observations and forwards them to a server. Create a Influxstatsd object, use it to create metrics, and pass those metrics as dependencies to the components that will use them.
All metrics are buffered until WriteTo is called. Counters and gauges are aggregated into a single observation per timeseries per write. Timings and histograms are buffered but not aggregated.
To regularly report metrics to an io.Writer, use the WriteLoop helper method. To send to a InfluxStatsD server, use the SendLoop helper method.
func New ¶
func New(prefix string, logger log.Logger, lvs ...string) *Influxstatsd
New returns a Influxstatsd object that may be used to create metrics. Prefix is applied to all created metrics. Callers must ensure that regular calls to WriteTo are performed, either manually or with one of the helper methods.
func (*Influxstatsd) NewCounter ¶
func (d *Influxstatsd) NewCounter(name string, sampleRate float64) *Counter
NewCounter returns a counter, sending observations to this Influxstatsd object.
func (*Influxstatsd) NewGauge ¶
func (d *Influxstatsd) NewGauge(name string) *Gauge
NewGauge returns a gauge, sending observations to this Influxstatsd object.
func (*Influxstatsd) NewHistogram ¶
func (d *Influxstatsd) NewHistogram(name string, sampleRate float64) *Histogram
NewHistogram returns a histogram whose observations are of an unspecified unit, and are forwarded to this Influxstatsd object.
func (*Influxstatsd) NewTiming ¶
func (d *Influxstatsd) NewTiming(name string, sampleRate float64) *Timing
NewTiming returns a histogram whose observations are interpreted as millisecond durations, and are forwarded to this Influxstatsd object.
func (*Influxstatsd) SendLoop ¶
func (d *Influxstatsd) SendLoop(c <-chan time.Time, network, address string)
SendLoop is a helper method that wraps WriteLoop, passing a managed connection to the network and address. Like WriteLoop, this method blocks until the channel is closed, so clients probably want to start it in its own goroutine. For typical usage, create a time.Ticker and pass its C channel to this method.
func (*Influxstatsd) WriteLoop ¶
func (d *Influxstatsd) WriteLoop(c <-chan time.Time, w io.Writer)
WriteLoop is a helper method that invokes WriteTo to the passed writer every time the passed channel fires. This method blocks until the channel is closed, so clients probably want to run it in its own goroutine. For typical usage, create a time.Ticker and pass its C channel to this method.
func (*Influxstatsd) WriteTo ¶
func (d *Influxstatsd) WriteTo(w io.Writer) (count int64, err error)
WriteTo flushes the buffered content of the metrics to the writer, in InfluxStatsD format. WriteTo abides best-effort semantics, so observations are lost if there is a problem with the write. Clients should be sure to call WriteTo regularly, ideally through the WriteLoop or SendLoop helper methods.
type Timing ¶
type Timing struct {
// contains filtered or unexported fields
}
Timing is a InfluxStatsD timing, or metrics.Histogram. Observations are forwarded to a Influxstatsd object, and collected (but not aggregated) per timeseries.
Source Files