l2met

Documentation

Overview

Package l2met provides a basic log-based metrics provider for cases where a real provider is not available.

Index

• type Provider
  • func New(l logrus.FieldLogger) *Provider
  • func (p *Provider) Flush() error
  • func (*Provider) NewCardinalityCounter(string) xmetrics.CardinalityCounter
  • func (p *Provider) NewCounter(name string) metrics.Counter
  • func (p *Provider) NewExplicitHistogram(name string, fn xmetrics.DistributionFunc) metrics.Histogram
  • func (p *Provider) NewGauge(name string) metrics.Gauge
  • func (p *Provider) NewHistogram(name string, buckets int) metrics.Histogram
  • func (p *Provider) Run(ctx context.Context) error
  • func (p *Provider) Stop()

Types

type Provider

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

Provider provides constructors for creating, tracking, and logging metrics.

func New

func New(l logrus.FieldLogger) *Provider

New returns a metrics provider for constructing and tracing metrics to report.

func (*Provider) Flush

func (p *Provider) Flush() error

Flush implements Provider.

func (*Provider) NewCardinalityCounter

func (*Provider) NewCardinalityCounter(string) xmetrics.CardinalityCounter

NewCardinalityCounter implements the heroku/x metrics Provider interface. It is not implemented for the log-based provider.

func (*Provider) NewCounter

func (p *Provider) NewCounter(name string) metrics.Counter

NewCounter implements Provider.

func (*Provider) NewExplicitHistogram

func (p *Provider) NewExplicitHistogram(name string, fn xmetrics.DistributionFunc) metrics.Histogram

func (*Provider) NewGauge

func (p *Provider) NewGauge(name string) metrics.Gauge

NewGauge implements Provider.

func (*Provider) NewHistogram

func (p *Provider) NewHistogram(name string, buckets int) metrics.Histogram

NewHistogram implements Provider.

func (*Provider) Run

func (p *Provider) Run(ctx context.Context) error

Run starts the provider, logging metrics once per minute until the context is canceled.

func (*Provider) Stop

func (p *Provider) Stop()

Stop implements Provider.