observability

Documentation

Index

• Constants
• Variables
• func InitTelemetry(logger *zap.Logger, config *Config) (metric.MeterProvider, error)
• func RegisterExtraMetrics(selectors []string, mp metric.MeterProvider)
• func StartServer(exporter *prometheus.Exporter, logger *zap.Logger, port string) error
• type Config
• type OtlpGrpcConfig
• type PrometheusConfig
• type StdoutConfig

Constants

const (
	KindlingServiceNamePrefix = "kindling"
	StdoutKindExporter        = "stdout"
	OtlpGrpcKindExporter      = "otlp"
	PrometheusKindExporter    = "prometheus"
)

const Int64BoundaryMultiplier = 1e6

Variables

var DefaultConfig = Config{
	ExportKind:  "stdout",
	PromCfg:     nil,
	OtlpGrpcCfg: nil,
	StdoutCfg:   &StdoutConfig{CollectPeriod: 10 * time.Second},
}

Functions

func InitTelemetry

func InitTelemetry(logger *zap.Logger, config *Config) (metric.MeterProvider, error)

func RegisterExtraMetrics

func RegisterExtraMetrics(selectors []string, mp metric.MeterProvider)

func StartServer

func StartServer(exporter *prometheus.Exporter, logger *zap.Logger, port string) error

Types

type Config

type Config struct {
	ExportKind  string            `mapstructure:"export_kind"`
	PromCfg     *PrometheusConfig `mapstructure:"prometheus"`
	OtlpGrpcCfg *OtlpGrpcConfig   `mapstructure:"otlp"`
	StdoutCfg   *StdoutConfig     `mapstructure:"stdout"`
}

type OtlpGrpcConfig

type OtlpGrpcConfig struct {
	CollectPeriod time.Duration `mapstructure:"collect_period,omitempty"`
	Endpoint      string        `mapstructure:"endpoint,omitempty"`
}

type PrometheusConfig

type PrometheusConfig struct {
	Port         string   `mapstructure:"port,omitempty"`
	ExtraMetrics []string `mapstructure:"extra_metrics"`
}

type StdoutConfig

type StdoutConfig struct {
	CollectPeriod time.Duration `mapstructure:"collect_period,omitempty"`
}