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(params MeterParams) om.Meter
• func NewNoopMeter() om.Meter
• func NewReader(cfg *Config) (sm.Reader, error)
• type Config
  • func (c *Config) GetKey() (string, error)
  • func (c *Config) HasKey() bool
  • func (c *Config) IsOTLP() bool
  • func (c *Config) IsPrometheus() bool
• type MeterParams

Variables

var Module = fx.Options(
	fx.Provide(NewReader),
	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(params MeterParams) om.Meter

NewMeter for metrics.

func NewNoopMeter

func NewNoopMeter() om.Meter

NewNoopMeter for metrics.

func NewReader

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

NewReader for metrics.

Types

type Config

type Config struct {
	Kind string `yaml:"kind,omitempty" json:"kind,omitempty" toml:"kind,omitempty"`
	Host string `yaml:"host,omitempty" json:"host,omitempty" toml:"host,omitempty"`
	Key  string `yaml:"key,omitempty" json:"key,omitempty" toml:"key,omitempty"`
}

Config for metrics.

func (*Config) GetKey

func (c *Config) GetKey() (string, error)

GetKey for metrics.

func (*Config) HasKey

func (c *Config) HasKey() bool

HasKey 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

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

MeterParams for metrics.