observability

Documentation

Overview

Package observability provides metrics, profiling, and etc.

Index

• Variables
• func NewProfService() run.Service
• func UpdatePath(path string)
• type Collector
  • func (c *Collector) Register(name string, getter MetricsGetter)
  • func (c *Collector) Unregister(name string)
• type Factory
  • func (f *Factory) NewCounter(name string, labelNames ...string) meter.Counter
  • func (f *Factory) NewGauge(name string, labelNames ...string) meter.Gauge
  • func (f *Factory) NewHistogram(name string, buckets meter.Buckets, labelNames ...string) meter.Histogram
• type MetricsGetter
• type MetricsRegistry
  • func NewMetricService(metadata metadata.Repo, pipeline queue.Client, nodeType string, ...) MetricsRegistry
• type SchedulerMetrics
  • func NewSchedulerMetrics(factory *Factory) *SchedulerMetrics
  • func (sm *SchedulerMetrics) Collect(job string, m *timestamp.SchedulerMetrics)
• type Service

Variables

var (
	// RootScope is the root scope for all metrics.
	RootScope = meter.NewHierarchicalScope("banyandb", "_")
	// SystemScope is the system scope for all metrics.
	SystemScope = RootScope.SubScope("system")
)

var MetricsCollector = Collector{
	// contains filtered or unexported fields
}

MetricsCollector is a global metrics collector.

Functions

func NewProfService

func NewProfService() run.Service

NewProfService returns a pprof service.

func UpdatePath

func UpdatePath(path string)

UpdatePath updates a path to monitoring its disk usage.

Types

type Collector

type Collector struct {
	// contains filtered or unexported fields
}

Collector is a metrics collector.

func (*Collector) Register

func (c *Collector) Register(name string, getter MetricsGetter)

Register registers a metrics getter.

func (*Collector) Unregister

func (c *Collector) Unregister(name string)

Unregister unregisters a metrics getter.

type Factory

type Factory struct {
	// contains filtered or unexported fields
}

Factory is the factory for creating metrics.

func (*Factory) NewCounter

func (f *Factory) NewCounter(name string, labelNames ...string) meter.Counter

NewCounter init and return the counterCollection.

func (*Factory) NewGauge

func (f *Factory) NewGauge(name string, labelNames ...string) meter.Gauge

NewGauge init and return the gaugeCollection.

func (*Factory) NewHistogram

func (f *Factory) NewHistogram(name string, buckets meter.Buckets, labelNames ...string) meter.Histogram

NewHistogram init and return the histogramCollection.

type MetricsGetter

type MetricsGetter func()

MetricsGetter is a function that collects metrics.

type MetricsRegistry

type MetricsRegistry interface {
	run.Service
	// With returns a factory with the given scope.
	With(scope meter.Scope) *Factory
	// NativeEnabled returns whether the native mode is enabled.
	NativeEnabled() bool
}

MetricsRegistry is the interface for metrics registry.

func NewMetricService

func NewMetricService(metadata metadata.Repo, pipeline queue.Client, nodeType string, nodeSelector native.NodeSelector) MetricsRegistry

NewMetricService returns a metric service.

type SchedulerMetrics

type SchedulerMetrics struct {
	// contains filtered or unexported fields
}

SchedulerMetrics is the metrics for scheduler.

func NewSchedulerMetrics

func NewSchedulerMetrics(factory *Factory) *SchedulerMetrics

NewSchedulerMetrics creates a new scheduler metrics.

func (*SchedulerMetrics) Collect

func (sm *SchedulerMetrics) Collect(job string, m *timestamp.SchedulerMetrics)

Collect collects the scheduler metrics.

type Service

type Service interface {
	run.PreRunner
	run.Service
}

Service type for Metric Service.