ActiveGo 1.8Package statsd
Overview ▹
Index ▹
type Counter ¶
Counter is a StatsD counter. Observations are forwarded to a Statsd object, and aggregated (summed) per timeseries.
type Counter struct {
// contains filtered or unexported fields
}
func (*Counter) Add ¶
func (c *Counter) Add(delta float64)
Add implements metrics.Counter.
func (*Counter) With ¶
func (c *Counter) With(...string) metrics.Counter
With is a no-op.
type Gauge ¶
Gauge is a StatsD gauge. Observations are forwarded to a Statsd object, and aggregated (the last observation selected) per timeseries.
type Gauge struct {
// contains filtered or unexported fields
}
func (*Gauge) Add ¶
func (g *Gauge) Add(delta float64)
Add implements metrics.Gauge.
func (*Gauge) Set ¶
func (g *Gauge) Set(value float64)
Set implements metrics.Gauge.
func (*Gauge) With ¶
func (g *Gauge) With(...string) metrics.Gauge
With is a no-op.
type Statsd ¶
Statsd receives metrics observations and forwards them to a StatsD server. Create a Statsd 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 are buffered but not aggregated.
To regularly report metrics to an io.Writer, use the WriteLoop helper method. To send to a StatsD server, use the SendLoop helper method.
type Statsd struct {
// contains filtered or unexported fields
}
func New ¶
func New(prefix string, logger log.Logger) *Statsd
New returns a Statsd 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 (*Statsd) NewCounter ¶
func (s *Statsd) NewCounter(name string, sampleRate float64) *Counter
NewCounter returns a counter, sending observations to this Statsd object.
func (*Statsd) NewGauge ¶
func (s *Statsd) NewGauge(name string) *Gauge
NewGauge returns a gauge, sending observations to this Statsd object.
func (*Statsd) NewTiming ¶
func (s *Statsd) NewTiming(name string, sampleRate float64) *Timing
NewTiming returns a histogram whose observations are interpreted as millisecond durations, and are forwarded to this Statsd object.
func (*Statsd) SendLoop ¶
func (s *Statsd) 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 (*Statsd) WriteLoop ¶
func (s *Statsd) 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 (*Statsd) WriteTo ¶
func (s *Statsd) WriteTo(w io.Writer) (count int64, err error)
WriteTo flushes the buffered content of the metrics to the writer, in StatsD 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 ¶
Timing is a StatsD timing, or metrics.Histogram. Observations are forwarded to a Statsd object, and collected (but not aggregated) per timeseries.
type Timing struct {
// contains filtered or unexported fields
}
func (*Timing) Observe ¶
func (t *Timing) Observe(value float64)
Observe implements metrics.Histogram. Value is interpreted as milliseconds.
func (*Timing) With ¶
func (t *Timing) With(...string) metrics.Histogram
With is a no-op.