metrics

Documentation

Overview

Package metrics defines a set of basic building blocks for instrumenting Sonic gateways

Index

• Constants
• func ConfigGetter(e config.ExtraConfig) interface{}
• func NewDummyRegistry() metrics.Registry
• func NewProxyMiddleware(layer, name string, pm *ProxyMetrics) proxy.Middleware
• type Config
• type DummyRegistry
  • func (r DummyRegistry) Each(_ func(string, interface{}))
  • func (r DummyRegistry) Get(_ string) interface{}
  • func (r DummyRegistry) GetAll() map[string]map[string]interface{}
  • func (r DummyRegistry) GetOrRegister(_ string, i interface{}) interface{}
  • func (r DummyRegistry) Register(_ string, _ interface{}) error
  • func (r DummyRegistry) RunHealthchecks()
  • func (r DummyRegistry) Unregister(_ string)
  • func (r DummyRegistry) UnregisterAll()
• type HistogramData
• type Metrics
  • func New(ctx context.Context, e config.ExtraConfig, l log.Logger) *Metrics
  • func (m *Metrics) BackendFactory(segmentName string, next proxy.BackendFactory) proxy.BackendFactory
  • func (m *Metrics) DefaultBackendFactory() proxy.BackendFactory
  • func (m *Metrics) NewProxyMiddleware(layer, name string) proxy.Middleware
  • func (m *Metrics) ProxyFactory(segmentName string, next proxy.Factory) proxy.FactoryFunc
  • func (m *Metrics) Snapshot() Stats
  • func (m *Metrics) TakeSnapshot() Stats
• type ProxyMetrics
  • func NewProxyMetrics(parent *metrics.Registry) *ProxyMetrics
  • func (rm *ProxyMetrics) Counter(labels ...string) metrics.Counter
  • func (rm *ProxyMetrics) Histogram(labels ...string) metrics.Histogram
• type RouterMetrics
  • func NewRouterMetrics(parent *metrics.Registry) *RouterMetrics
  • func (rm *RouterMetrics) Aggregate()
  • func (rm *RouterMetrics) Connection(TLS *tls.ConnectionState)
  • func (rm *RouterMetrics) Disconnection()
  • func (rm *RouterMetrics) RegisterResponseWriterMetrics(name string)
• type Stats
  • func NewStats() Stats

Constants

const Namespace = "github.com/starvn/sonic/telemetry/metrics"

Functions

func ConfigGetter

func ConfigGetter(e config.ExtraConfig) interface{}

func NewDummyRegistry

func NewDummyRegistry() metrics.Registry

func NewProxyMiddleware

func NewProxyMiddleware(layer, name string, pm *ProxyMetrics) proxy.Middleware

Types

type Config

type Config struct {
	ProxyDisabled    bool
	RouterDisabled   bool
	BackendDisabled  bool
	CollectionTime   time.Duration
	ListenAddr       string
	EndpointDisabled bool
}

type DummyRegistry

type DummyRegistry struct{}

func (DummyRegistry) Each

func (r DummyRegistry) Each(_ func(string, interface{}))

func (DummyRegistry) Get

func (r DummyRegistry) Get(_ string) interface{}

func (DummyRegistry) GetAll

func (r DummyRegistry) GetAll() map[string]map[string]interface{}

func (DummyRegistry) GetOrRegister

func (r DummyRegistry) GetOrRegister(_ string, i interface{}) interface{}

func (DummyRegistry) Register

func (r DummyRegistry) Register(_ string, _ interface{}) error

func (DummyRegistry) RunHealthchecks

func (r DummyRegistry) RunHealthchecks()

func (DummyRegistry) Unregister

func (r DummyRegistry) Unregister(_ string)

func (DummyRegistry) UnregisterAll

func (r DummyRegistry) UnregisterAll()

type HistogramData

type HistogramData struct {
	Max         int64
	Min         int64
	Mean        float64
	Stddev      float64
	Variance    float64
	Percentiles []float64
}

type Metrics

type Metrics struct {
	Config   *Config
	Proxy    *ProxyMetrics
	Router   *RouterMetrics
	Registry *metrics.Registry
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, e config.ExtraConfig, l log.Logger) *Metrics

func (*Metrics) BackendFactory

func (m *Metrics) BackendFactory(segmentName string, next proxy.BackendFactory) proxy.BackendFactory

func (*Metrics) DefaultBackendFactory

func (m *Metrics) DefaultBackendFactory() proxy.BackendFactory

func (*Metrics) NewProxyMiddleware

func (m *Metrics) NewProxyMiddleware(layer, name string) proxy.Middleware

func (*Metrics) ProxyFactory

func (m *Metrics) ProxyFactory(segmentName string, next proxy.Factory) proxy.FactoryFunc

func (*Metrics) Snapshot

func (m *Metrics) Snapshot() Stats

func (*Metrics) TakeSnapshot

func (m *Metrics) TakeSnapshot() Stats

type ProxyMetrics

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

func NewProxyMetrics

func NewProxyMetrics(parent *metrics.Registry) *ProxyMetrics

func (*ProxyMetrics) Counter

func (rm *ProxyMetrics) Counter(labels ...string) metrics.Counter

func (*ProxyMetrics) Histogram

func (rm *ProxyMetrics) Histogram(labels ...string) metrics.Histogram

type RouterMetrics

type RouterMetrics struct {
	ProxyMetrics
	// contains filtered or unexported fields
}

func NewRouterMetrics

func NewRouterMetrics(parent *metrics.Registry) *RouterMetrics

func (*RouterMetrics) Aggregate

func (rm *RouterMetrics) Aggregate()

func (*RouterMetrics) Connection

func (rm *RouterMetrics) Connection(TLS *tls.ConnectionState)

func (*RouterMetrics) Disconnection

func (rm *RouterMetrics) Disconnection()

func (*RouterMetrics) RegisterResponseWriterMetrics

func (rm *RouterMetrics) RegisterResponseWriterMetrics(name string)

type Stats

type Stats struct {
	Time       int64
	Counters   map[string]int64
	Gauges     map[string]int64
	Histograms map[string]HistogramData
}

func NewStats

func NewStats() Stats