observability

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 17, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package observability provides a subsystem for building observability components.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

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

	// Optional: metrics writer/reader for ResourcesMonitor
	// If nil, ResourcesMonitor won't be created
	MetricsWriter *metrics.VictoriaMetricsWriter
	MetricsReader *metrics.VictoriaMetricsReader
}

Config holds required configuration for the observability subsystem.

type Option

type Option func(*buildOpts)

Option configures optional dependencies for the observability subsystem.

func WithLogReader

func WithLogReader(lr *observability.LogReader) Option

WithLogReader overrides the default LogReader.

func WithLogWriter

func WithLogWriter(lw *observability.PersistentLogWriter) Option

WithLogWriter overrides the default PersistentLogWriter.

func WithStatusMonitor

func WithStatusMonitor(sm *observability.StatusMonitor) Option

WithStatusMonitor overrides the default StatusMonitor.

type Subsystem

type Subsystem struct {
	StatusMonitor    *observability.StatusMonitor
	LogWriter        *observability.PersistentLogWriter
	LogReader        *observability.LogReader
	LogsMaintainer   *observability.LogsMaintainer
	ResourcesMonitor *observability.ResourcesMonitor
}

Subsystem contains the built observability components.

func New

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

New creates a new observability subsystem with all components.

func (*Subsystem) Close

func (s *Subsystem) Close() error

Close cleans up observability subsystem resources.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL