statter

README

Go stats clients

Overview

Install with:

go get github.com/hamba/statter/v2

Supported stats clients

• L2met Writes l2met to a Logger interface
• Statsd Writes statsd to UDP
• Prometheus Exposes stats via HTTP
• VictoriaMetrics Exposes stats via HTTP

Note: This project has renamed the default branch from master to main. You will need to update your local environment.

Usage

reporter := statsd.New(statsdAddr, "")
stats := statter.New(reporter, 10*time.Second).With("my-prefix")

stats.Counter("my-counter", tags.Str("tag", "value")).Inc(1)

Documentation

Overview

Package statter is a statistics collector with multiple reporters..

Index

• Variables
• type Counter
  • func (c *Counter) Inc(v int64)
• type Gauge
  • func (g *Gauge) Set(v float64)
• type Histogram
  • func (h *Histogram) Observe(v float64)
• type HistogramReporter
• type Option
  • func WithPercentileSamples(n int) Option
  • func WithPercentiles(p []float64) Option
  • func WithPrefix(prefix string) Option
  • func WithSeparator(sep string) Option
  • func WithTags(tags ...Tag) Option
• type Reporter
• type Statter
  • func New(r Reporter, interval time.Duration, opts ...Option) *Statter
  • func (s *Statter) Close() error
  • func (s *Statter) Counter(name string, tags ...Tag) *Counter
  • func (s *Statter) FullName(name string) string
  • func (s *Statter) Gauge(name string, tags ...Tag) *Gauge
  • func (s *Statter) Histogram(name string, tags ...Tag) *Histogram
  • func (s *Statter) Reporter() Reporter
  • func (s *Statter) Timing(name string, tags ...Tag) *Timing
  • func (s *Statter) With(prefix string, tags ...Tag) *Statter
• type Tag
• type Timing
  • func (t *Timing) Observe(d time.Duration)
• type TimingReporter

Examples

• Counter.Inc
• Gauge.Set
• Histogram.Observe

Variables

var DiscardReporter = discardReporter{}

DiscardReporter is a reporter that discards all stats.

Types

type Counter

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

Counter implements a counter.

func (*Counter) Inc

func (c *Counter) Inc(v int64)

Inc increments the counter.

Example

stat := statter.New(statter.DiscardReporter, time.Second)

stat.Counter("my_counter", tags.Str("tag", "value")).Inc(1)

type Gauge

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

Gauge implements a gauge.

func (*Gauge) Set

func (g *Gauge) Set(v float64)

Set sets the gauge value.

Example

stat := statter.New(statter.DiscardReporter, time.Second)

stat.Gauge("my_gauge", tags.Int("int", 1)).Set(1.23)

type Histogram

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

Histogram implements a histogram.

func (*Histogram) Observe

func (h *Histogram) Observe(v float64)

Observe observes a histogram value.

Example

stat := statter.New(statter.DiscardReporter, time.Second)

stat.Histogram("my_histo", tags.Str("label", "blah")).Observe(2.34)

type HistogramReporter

type HistogramReporter interface {
	Histogram(name string, tags [][2]string) func(v float64)
}

HistogramReporter represents a stats reporter that handles histograms.

type Option

type Option func(*config)

Option represents a statter option function.

func WithPercentileSamples

func WithPercentileSamples(n int) Option

WithPercentileSamples sets the number of samples taken to calculate percentiles.

func WithPercentiles

func WithPercentiles(p []float64) Option

WithPercentiles sets the percentiles to calculate and report for aggregated histograms and timings.

func WithPrefix

func WithPrefix(prefix string) Option

WithPrefix sets the initial prefix on a statter.

func WithSeparator

func WithSeparator(sep string) Option

WithSeparator sets the key separator on a statter.

func WithTags

func WithTags(tags ...Tag) Option

WithTags sets the initial tags on a statter.

type Reporter

type Reporter interface {
	Counter(name string, v int64, tags [][2]string)
	Gauge(name string, v float64, tags [][2]string)
}

Reporter represents a stats reporter.

type Statter

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

Statter collects and reports stats.

func New

func New(r Reporter, interval time.Duration, opts ...Option) *Statter

New returns a statter.

func (*Statter) Close

func (s *Statter) Close() error

Close closes the statter and reporter.

func (*Statter) Counter

func (s *Statter) Counter(name string, tags ...Tag) *Counter

Counter returns a counter for the given name and tags.

func (*Statter) FullName

func (s *Statter) FullName(name string) string

FullName returns the full name with prefix for the given name.

func (*Statter) Gauge

func (s *Statter) Gauge(name string, tags ...Tag) *Gauge

Gauge returns a gauge for the given name and tags.

func (*Statter) Histogram

func (s *Statter) Histogram(name string, tags ...Tag) *Histogram

Histogram returns a histogram for the given name and tags.

func (*Statter) Reporter

func (s *Statter) Reporter() Reporter

Reporter returns the stats reporter.

The reporter should not be used directly.

func (*Statter) Timing

func (s *Statter) Timing(name string, tags ...Tag) *Timing

Timing returns a timing for the given name and tags.

func (*Statter) With

func (s *Statter) With(prefix string, tags ...Tag) *Statter

With returns a statter with the given prefix and tags.

type Tag

type Tag [2]string

Tag is a stat tag.

type Timing

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

Timing implements a timing.

func (*Timing) Observe

func (t *Timing) Observe(d time.Duration)

Observe observes a timing duration.

If the reporter does not handle timings, the duration will be aggregated in milliseconds.

type TimingReporter

type TimingReporter interface {
	Timing(name string, tags [][2]string) func(v time.Duration)
}

TimingReporter represents a stats reporter that handles timings.