metrics

Documentation

Overview

Package metrics contains a sink interface to be used by clients to implement sink. It also provides a default NoopSink and LogSink for convenience

Index

• Constants
• func NewLogSink(logger loggers.Advanced) *logSink
• type MetricValue
• type Metrics
• type NoopSink
  • func NewNoopSink() *NoopSink
  • func (s *NoopSink) Send(ctx context.Context, m *Metrics) error
• type Sink

Constants

const (
	UNKNOWN byte = iota
	COUNTER
	GAUGE

	SinkTimeout = 1 * time.Second

	ChunkProcessingTimeMetricName    = "chunk_processing_time"
	ChunkLogicalRowsCountMetricName  = "chunk_num_logical_rows"
	ChunkAffectedRowsCountMetricName = "chunk_num_affected_rows"
)

Metric types.

Functions

func NewLogSink

func NewLogSink(logger loggers.Advanced) *logSink

Types

type MetricValue

type MetricValue struct {
	// Name is the metric name
	Name string

	// Value is the value of the metric.
	Value float64

	// Type is the metric type: GAUGE, COUNTER, and other const.
	Type byte
}

type Metrics

type Metrics struct {
	Values []MetricValue
}

Metrics are collection of MetricValues.

type NoopSink

type NoopSink struct{}

NoopSink is the default sink which does nothing

func NewNoopSink

func NewNoopSink() *NoopSink

func (*NoopSink) Send

func (s *NoopSink) Send(ctx context.Context, m *Metrics) error

type Sink

type Sink interface {
	// Send sends metrics to the sink. It must respect the context timeout, if any.
	Send(ctx context.Context, metrics *Metrics) error
}

Sink sends metrics to an external destination.