metrics

Documentation

Index

• Variables
• func IsEnabled(cfg *Config) bool
• func NewMeterProvider(params MeterProviderParams) om.MeterProvider
• func NewReader(fs os.FileSystem, cfg *Config) (sm.Reader, error)
• type Config
  • func (c *Config) IsOTLP() bool
  • func (c *Config) IsPrometheus() bool
• type Meter
  • func NewMeter(provider metric.MeterProvider, name env.Name) *Meter
  • func (m *Meter) MustFloat64Histogram(name, description string) metric.Float64Histogram
  • func (m *Meter) MustFloat64ObservableCounter(name, description string) metric.Float64ObservableCounter
  • func (m *Meter) MustInt64Counter(name, description string) metric.Int64Counter
  • func (m *Meter) MustInt64ObservableCounter(name, description string) metric.Int64ObservableCounter
  • func (m *Meter) MustInt64ObservableGauge(name, description string) metric.Int64ObservableGauge
  • func (m *Meter) MustRegisterCallback(f metric.Callback, instruments ...metric.Observable) metric.Registration
• type MeterProviderParams

Variables

var Module = fx.Options(
	fx.Provide(NewReader),
	fx.Provide(NewMeterProvider),
	fx.Provide(NewMeter),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for metrics.

func NewMeterProvider

func NewMeterProvider(params MeterProviderParams) om.MeterProvider

NewMeterProvider for metrics.

func NewReader

func NewReader(fs os.FileSystem, cfg *Config) (sm.Reader, error)

NewReader for metrics. A nil reader means disabled.

Types

type Config

type Config struct {
	Headers header.Map `yaml:"headers,omitempty" json:"headers,omitempty" toml:"headers,omitempty"`
	Kind    string     `yaml:"kind,omitempty" json:"kind,omitempty" toml:"kind,omitempty"`
	URL     string     `yaml:"url,omitempty" json:"url,omitempty" toml:"url,omitempty"`
}

Config for metrics.

func (*Config) IsOTLP

func (c *Config) IsOTLP() bool

IsOTLP configuration.

func (*Config) IsPrometheus

func (c *Config) IsPrometheus() bool

IsPrometheus configuration.

type Meter

type Meter struct {
	metric.Meter
}

Meter using otel.

func NewMeter

func NewMeter(provider metric.MeterProvider, name env.Name) *Meter

NewMeter for metrics.

func (*Meter) MustFloat64Histogram

func (m *Meter) MustFloat64Histogram(name, description string) metric.Float64Histogram

MustFloat64Histogram for metrics.

func (*Meter) MustFloat64ObservableCounter

func (m *Meter) MustFloat64ObservableCounter(name, description string) metric.Float64ObservableCounter

MustFloat64ObservableCounter for metrics.

func (*Meter) MustInt64Counter

func (m *Meter) MustInt64Counter(name, description string) metric.Int64Counter

MustInt64Counter for metrics.

func (*Meter) MustInt64ObservableCounter

func (m *Meter) MustInt64ObservableCounter(name, description string) metric.Int64ObservableCounter

MustInt64ObservableCounter for metrics.

func (*Meter) MustInt64ObservableGauge

func (m *Meter) MustInt64ObservableGauge(name, description string) metric.Int64ObservableGauge

MustFloat64Histogram for metrics.

func (*Meter) MustRegisterCallback

func (m *Meter) MustRegisterCallback(f metric.Callback, instruments ...metric.Observable) metric.Registration

MustRegisterCallback for metrics.

type MeterProviderParams

type MeterProviderParams struct {
	fx.In

	Lifecycle   fx.Lifecycle
	Config      *Config
	Reader      sm.Reader
	Environment env.Environment
	Version     env.Version
	Name        env.Name
}

MeterProviderParams for metrics.