stats

Documentation

Overview

Package stats uses uber-go/tally for reporting hierarchical stats. Tally supports multiple sinks including prometheus, m3, and statsd. xds-relay currently defaults to statsd, but this will be made configurable in the future to support the other sink alternatives.

Index

• func NewMockScope(prefix string) tally.TestScope
• func NewRootScope(config Config) (tally.Scope, io.Closer, error)
• func NewStatsdPointTagsReporter(statsdClient statsd.Statter) tally.StatsReporter
• type Config

Functions

func NewMockScope

func NewMockScope(prefix string) tally.TestScope

NewMockScope mocks a stats scope for testing.

func NewRootScope

func NewRootScope(config Config) (tally.Scope, io.Closer, error)

NewRootScope creates a new root Scope with the set of configured options and statsd reporter.

func NewStatsdPointTagsReporter

func NewStatsdPointTagsReporter(statsdClient statsd.Statter) tally.StatsReporter

Types

type Config

type Config struct {
	// StatsdAddress that the statsd sink is running on, with format addr:port.
	StatsdAddress string
	// RootPrefix is the prefix for the root scope.
	RootPrefix string
	// The maximum interval for packet sending. If set to 0 it defaults to 300ms.
	FlushInterval time.Duration
}

Config holds the configuration options for stats reporting.