circonus

Documentation

Overview

Package circonus provides a Circonus backend for metrics.

Index

• type Circonus
  • func New(m *circonusgometrics.CirconusMetrics) *Circonus
  • func (c *Circonus) NewCounter(name string) *Counter
  • func (c *Circonus) NewGauge(name string) *Gauge
  • func (c *Circonus) NewHistogram(name string) *Histogram
• type Counter
  • func (c *Counter) Add(delta float64)
  • func (c *Counter) With(labelValues ...string) metrics.Counter
• type Gauge
  • func (g *Gauge) Set(value float64)
  • func (g *Gauge) With(labelValues ...string) metrics.Gauge
• type Histogram
  • func (h *Histogram) Observe(value float64)
  • func (h *Histogram) With(labelValues ...string) metrics.Histogram

Types

type Circonus

type Circonus struct {
	// contains filtered or unexported fields
}

Circonus wraps a CirconusMetrics object and provides constructors for each of the Go kit metrics. The CirconusMetrics object manages aggregation of observations and emission to the Circonus server.

func New

func New(m *circonusgometrics.CirconusMetrics) *Circonus

New creates a new Circonus object wrapping the passed CirconusMetrics, which the caller should create and set in motion. The Circonus object can be used to construct individual Go kit metrics.

func (*Circonus) NewCounter

func (c *Circonus) NewCounter(name string) *Counter

NewCounter returns a counter metric with the given name.

func (*Circonus) NewGauge

func (c *Circonus) NewGauge(name string) *Gauge

NewGauge returns a gauge metric with the given name.

func (*Circonus) NewHistogram

func (c *Circonus) NewHistogram(name string) *Histogram

NewHistogram returns a histogram metric with the given name.

type Counter

type Counter struct {
	// contains filtered or unexported fields
}

Counter is a Circonus implementation of a counter metric.

func (*Counter) Add

func (c *Counter) Add(delta float64)

Add implements Counter. Delta is converted to uint64; precision will be lost.

func (*Counter) With

func (c *Counter) With(labelValues ...string) metrics.Counter

With implements Counter, but is a no-op, because Circonus metrics have no concept of per-observation label values.

type Gauge

type Gauge struct {
	// contains filtered or unexported fields
}

Gauge is a Circonus implementation of a gauge metric.

func (*Gauge) Set

func (g *Gauge) Set(value float64)

Set implements Gauge.

func (*Gauge) With

func (g *Gauge) With(labelValues ...string) metrics.Gauge

With implements Gauge, but is a no-op, because Circonus metrics have no concept of per-observation label values.

type Histogram

type Histogram struct {
	// contains filtered or unexported fields
}

Histogram is a Circonus implementation of a histogram metric.

func (*Histogram) Observe

func (h *Histogram) Observe(value float64)

Observe implements Histogram. No precision is lost.

func (*Histogram) With

func (h *Histogram) With(labelValues ...string) metrics.Histogram

With implements Histogram, but is a no-op, because Circonus metrics have no concept of per-observation label values.