metrics

Documentation

Index

• func RegisterSink(name string, f SinkFunc)
• type BaseMetric
• type KafkaGauge
  • func NewKafkaGauge(name, key string, meta map[string]any) KafkaGauge
  • func (m KafkaGauge) Snapshot() metrics.Gauge
• type KafkaMeter
  • func NewKafkaMeter(name, key string, meta map[string]any) KafkaMeter
  • func (m KafkaMeter) Snapshot() metrics.Meter
• type KafkaSource
  • func NewKafkaSource(sink Sink) (*KafkaSource, error)
  • func (s *KafkaSource) Close() error
  • func (s *KafkaSource) Run() chan any
• type Sink
  • func New(name string) (Sink, error)
• type SinkFunc

Functions

func RegisterSink

func RegisterSink(name string, f SinkFunc)

RegisterSink register a new sink to be used by kafka-offset

Types

type BaseMetric

type BaseMetric struct {
	Name      string
	Key       string
	Timestamp time.Time
	Meta      map[string]any
}

BaseMetric base metrics for gauge and meter

type KafkaGauge

type KafkaGauge struct {
	BaseMetric
	metrics.Gauge
}

KafkaGauge gauge with metadata

func NewKafkaGauge

func NewKafkaGauge(name, key string, meta map[string]any) KafkaGauge

NewKafkaGauge build new kafka gauge

func (KafkaGauge) Snapshot

func (m KafkaGauge) Snapshot() metrics.Gauge

Snapshot get gauge snapshot and set Timestamp

type KafkaMeter

type KafkaMeter struct {
	BaseMetric
	metrics.Meter
}

KafkaMeter meter with metadata

func NewKafkaMeter

func NewKafkaMeter(name, key string, meta map[string]any) KafkaMeter

NewKafkaMeter build a new Kafka Meter

func (KafkaMeter) Snapshot

func (m KafkaMeter) Snapshot() metrics.Meter

Snapshot get meter snapshot and set Timestamp

type KafkaSource

type KafkaSource struct {
	sync.WaitGroup
	// contains filtered or unexported fields
}

KafkaSource represent kafka cluster source metrics

func NewKafkaSource

func NewKafkaSource(sink Sink) (*KafkaSource, error)

NewKafkaSource build new kafka source scraper

func (*KafkaSource) Close

func (s *KafkaSource) Close() error

Close close kafka client

func (*KafkaSource) Run

func (s *KafkaSource) Run() chan any

Run launch scrape and return stopCh to end scraping

type Sink

type Sink interface {
	GetMetricsChan() chan<- []any
	Close() error
}

Sink reprensent sink for kafka metrics

func New

func New(name string) (Sink, error)

New build sink by it's regitred name

type SinkFunc

type SinkFunc func() (Sink, error)

SinkFunc build new KafkaSink