observability

Documentation

Overview

Package observability provides metrics, profiling, and etc.

Index

• Variables
• func MetricsServerInterceptor() (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor)
• func NewMeterProvider(_ meter.Scope) meter.Provider
• func NewMetricService() run.Service
• func NewProfService() run.Service
• func UpdateAddress(name, address string)
• func UpdatePath(path string)
• type Collector
  • func (c *Collector) Register(name string, getter MetricsGetter)
  • func (c *Collector) Unregister(name string)
• type DiskUsage
• type ErrorResponse
• type MetricsGetter
• type SystemInfo

Variables

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

MetricsCollector is a global metrics collector.

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

Functions

func MetricsServerInterceptor

func MetricsServerInterceptor() (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor)

MetricsServerInterceptor returns a grpc.UnaryServerInterceptor and a grpc.StreamServerInterceptor.

func NewMeterProvider

func NewMeterProvider(_ meter.Scope) meter.Provider

NewMeterProvider returns a meter.Provider based on the given scope.

func NewMetricService

func NewMetricService() run.Service

NewMetricService returns a metric service.

func NewProfService

func NewProfService() run.Service

NewProfService returns a pprof service.

func UpdateAddress

func UpdateAddress(name, address string)

UpdateAddress updates the address of the given name.

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 DiskUsage

type DiskUsage struct {
	Capacity uint64 `json:"capacity"`
	Used     uint64 `json:"used"`
}

DiskUsage represents the disk usage for a given path.

type ErrorResponse

type ErrorResponse struct {
	Message       string `json:"message"`
	OriginalError string `json:"original_error,omitempty"`
}

ErrorResponse represents the error response.

type MetricsGetter

type MetricsGetter func()

MetricsGetter is a function that collects metrics.

type SystemInfo

type SystemInfo struct {
	Addresses   map[string]string     `json:"addresses"`
	DiskUsages  map[string]*DiskUsage `json:"disk_usages"`
	NodeID      string                `json:"node_id"`
	Hostname    string                `json:"hostname"`
	Roles       []string              `json:"roles"`
	Uptime      uint64                `json:"uptime"`
	CPUUsage    float64               `json:"cpu_usage"`
	MemoryUsage float64               `json:"memory_usage"`
	sync.RWMutex
}

SystemInfo represents the system information of a node.