metrics

Documentation

Index

• Variables
• func IsEnabled(cfg *Config) bool
• func MustFloat64Histogram(meter metric.Meter, name, description string) metric.Float64Histogram
• func MustFloat64ObservableCounter(meter metric.Meter, name, description string) metric.Float64ObservableCounter
• func MustInt64Counter(meter metric.Meter, name, description string) metric.Int64Counter
• func MustInt64ObservableCounter(meter metric.Meter, name, description string) metric.Int64ObservableCounter
• func MustInt64ObservableGauge(meter metric.Meter, name, description string) metric.Int64ObservableGauge
• func NewMeter(provider om.MeterProvider, name env.Name) om.Meter
• func NewMeterProvider(params MeterProviderParams) om.MeterProvider
• func NewReader(cfg *Config) (sm.Reader, error)
• type Config
  • func (c *Config) IsOTLP() bool
  • func (c *Config) IsPrometheus() bool
• type MeterParams
• 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 MustFloat64Histogram

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

MustFloat64Histogram for metrics.

func MustFloat64ObservableCounter

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

MustFloat64ObservableCounter for metrics.

func MustInt64Counter

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

MustInt64Counter for metrics.

func MustInt64ObservableCounter

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

MustInt64ObservableCounter for metrics.

func MustInt64ObservableGauge

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

MustFloat64Histogram for metrics.

func NewMeter

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

NewMeter for metrics.

func NewMeterProvider

func NewMeterProvider(params MeterProviderParams) om.MeterProvider

NewMeterProvider for metrics.

func NewReader

func NewReader(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 MeterParams

type MeterParams struct {
	fx.In

	Config   *Config
	Provider om.MeterProvider
	Name     env.Name
}

MeterParams 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.