metrics

Documentation

Index

• Constants
• func NewMetricsServer(vertex *dfv1.Vertex, opts ...Option) *metricsServer
• type HealthChecker
• type Option
  • func NewMetricsOptions(ctx context.Context, vertex *dfv1.Vertex, serverHandler HealthChecker, ...) []Option
  • func WithHealthCheckExecutor(f func() error) Option
  • func WithLagReaders(r map[string]isb.LagReader) Option
  • func WithLookbackSeconds(seconds int64) Option
  • func WithRefreshInterval(d time.Duration) Option

Constants

const (
	LabelPipeline           = "pipeline"
	LabelVertex             = "vertex"
	LabelPeriod             = "period"
	LabelVertexReplicaIndex = "replica"
	LabelPartitionName      = "partition_name"

	VertexPendingMessages = "vertex_pending_messages"
)

Functions

func NewMetricsServer

func NewMetricsServer(vertex *dfv1.Vertex, opts ...Option) *metricsServer

NewMetricsServer returns a Prometheus metrics server instance, which can be used to start an HTTPS service to expose Prometheus metrics.

Types

type HealthChecker

type HealthChecker interface {
	// IsHealthy checks if the user defined container is healthy
	IsHealthy(ctx context.Context) error
}

HealthChecker is the interface to check if the user defined container is connected and ready to use

type Option

type Option func(*metricsServer)

func NewMetricsOptions

func NewMetricsOptions(ctx context.Context, vertex *dfv1.Vertex, serverHandler HealthChecker, readers []isb.BufferReader) []Option

NewMetricsOptions returns a metrics option list.

func WithHealthCheckExecutor

func WithHealthCheckExecutor(f func() error) Option

WithHealthCheckExecutor appends a health check executor

func WithLagReaders

func WithLagReaders(r map[string]isb.LagReader) Option

WithLagReaders sets the lag readers

func WithLookbackSeconds

func WithLookbackSeconds(seconds int64) Option

WithLookbackSeconds sets lookback seconds for pending calculation

func WithRefreshInterval

func WithRefreshInterval(d time.Duration) Option

WithRefreshInterval sets how often to refresh the pending information