metrics

Documentation

Overview

Package metrics provides a subsystem for building metrics collection components.

Index

• type Config
• type Option
  • func WithReader(r *metrics.VictoriaMetricsReader) Option
  • func WithWriter(w *metrics.VictoriaMetricsWriter) Option
  • func WithoutCPUMetrics() Option
  • func WithoutHTTPMetrics() Option
  • func WithoutMemoryMetrics() Option
• type Subsystem
  • func New(cfg Config, opts ...Option) (*Subsystem, error)
  • func (s *Subsystem) Close() error

Types

type Config

type Config struct {
	Log     *slog.Logger
	Address string        // VictoriaMetrics address (e.g., "localhost:8428")
	Timeout time.Duration // Request timeout (0 uses default of 30s)
}

Config holds required configuration for the metrics subsystem.

type Option

type Option func(*buildOpts)

Option configures optional dependencies for the metrics subsystem.

func WithReader

func WithReader(r *metrics.VictoriaMetricsReader) Option

WithReader overrides the default VictoriaMetricsReader.

func WithWriter

func WithWriter(w *metrics.VictoriaMetricsWriter) Option

WithWriter overrides the default VictoriaMetricsWriter.

func WithoutCPUMetrics

func WithoutCPUMetrics() Option

WithoutCPUMetrics disables building CPUUsage.

func WithoutHTTPMetrics

func WithoutHTTPMetrics() Option

WithoutHTTPMetrics disables building HTTPMetrics.

func WithoutMemoryMetrics

func WithoutMemoryMetrics() Option

WithoutMemoryMetrics disables building MemoryUsage.

type Subsystem

type Subsystem struct {
	Writer      *metrics.VictoriaMetricsWriter
	Reader      *metrics.VictoriaMetricsReader
	CPUUsage    *metrics.CPUUsage
	MemoryUsage *metrics.MemoryUsage
	HTTPMetrics *metrics.HTTPMetrics
}

Subsystem contains the built metrics components.

func New

func New(cfg Config, opts ...Option) (*Subsystem, error)

New creates a new metrics subsystem with all components.

func (*Subsystem) Close

func (s *Subsystem) Close() error

Close stops the metrics writer and cleans up resources.