metrics

Documentation

Overview

Package metrics provides the Provider interface for sending APM metrics

Index

• type Nop
  • func NewNop() *Nop
  • func (n *Nop) Shutdown(_ context.Context) error
  • func (n *Nop) Start(_ context.Context) error
• type OTLP
  • func (p *OTLP) Shutdown(ctx context.Context) error
  • func (p *OTLP) Start(ctx context.Context) error
• type Provider
  • func NewOTLP(cfg *config.OTLPMetrics, interval time.Duration, resource *resource.Resource) (Provider, error)

Types

type Nop

type Nop struct{}

Nop is a Provider that does nothing

func NewNop

func NewNop() *Nop

NewNop creates a new Nop Provider

func (*Nop) Shutdown

func (n *Nop) Shutdown(_ context.Context) error

Shutdown shuts down the Provider

func (*Nop) Start

func (n *Nop) Start(_ context.Context) error

Start starts the Provider

type OTLP

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

OTLP is an OTLP metrics provider

func (*OTLP) Shutdown

func (p *OTLP) Shutdown(ctx context.Context) error

Shutdown shuts down the provider

func (*OTLP) Start

func (p *OTLP) Start(ctx context.Context) error

Start just sets the provider as the OTel global meter provider

type Provider

type Provider interface {
	// Start starts the provider
	Start(context.Context) error
	// Shutdown shuts down the provider
	Shutdown(context.Context) error
}

Provider is a metrics provider

func NewOTLP

func NewOTLP(cfg *config.OTLPMetrics, interval time.Duration, resource *resource.Resource) (Provider, error)

NewOTLP returns a new OTLP metrics provider