instrument

Documentation

Index

• func Start(ctx context.Context, cfg *InternalMetricsConfig) context.Context
• type InternalMetrics
  • func FromContext(ctx context.Context) InternalMetrics
• type InternalMetricsConfig

Functions

func Start

func Start(ctx context.Context, cfg *InternalMetricsConfig) context.Context

Start in background an internal metrics handler and return a context containing it. The metrics handler can be later retrieved via FromContext function.

Types

type InternalMetrics

type InternalMetrics interface {
	InformerNew()
	InformerUpdate()
	InformerDelete()

	ClientConnect()
	ClientDisconnect()

	MessageSubmit()
	MessageSucceed()
	MessageTimeout()
	MessageError()
}

InternalMetrics accounts diverse events of the Beyla Cache service

func FromContext

func FromContext(ctx context.Context) InternalMetrics

FromContext returns the internal metrics handler from the context. If any. If no metrics handler has been defined, it will return a NOOP metrics handler.

type InternalMetricsConfig

type InternalMetricsConfig struct {
	Port int    `yaml:"port,omitempty" env:"BEYLA_K8S_CACHE_INTERNAL_METRICS_PROMETHEUS_PORT"`
	Path string `yaml:"path,omitempty" env:"BEYLA_K8S_CACHE_INTERNAL_METRICS_PROMETHEUS_PATH"`
}