monitor

package module

Go to main page

Versions in this module

v0

v0.3.0

Jul 17, 2026

Changes in this version

+ const RegistrySnapshotSchemaVersionV1

+ var ErrAggregationInvalidConfig = errors.New("invalid aggregation config")

+ var ErrAggregationInvalidLimits = errors.New("invalid aggregation limits")

+ var ErrAggregationLimit = errors.New("aggregation limit exceeded")

+ var ErrAggregationProviderContract = errors.New("aggregation provider contract violation")

+ var ErrAggregationSourceResult = errors.New("invalid aggregation source result")

+ var ErrRegistrySnapshotInvalidLimits = errors.New("invalid registry snapshot decode limits")

+ var ErrRegistrySnapshotLimit = errors.New("registry snapshot decode limit exceeded")

+ var ErrRegistrySnapshotMalformed = errors.New("malformed registry snapshot")

+ var ErrRegistrySnapshotUnknownVersion = errors.New("unknown registry snapshot version")

+ func EncodeRegistrySnapshot(w io.Writer, value *RegistrySnapshot) error

+ type AggregationConfig struct

+ GatherTimeout time.Duration

+ Limits AggregationLimits

+ Providers []SnapshotProvider

+ SnapshotCacheTTL time.Duration

+ func DefaultAggregationConfig() AggregationConfig

+ type AggregationLimits struct

+ MaxExpandedSeries int64

+ MaxFamilies int64

+ MaxHistogramBucketsPerSeries int64

+ MaxLabelBytesPerSeries int64

+ MaxLabelsPerSeries int64

+ MaxSeries int64

+ MaxSnapshotBytes int64

+ MaxSourceIDBytes int64

+ MaxSources int64

+ MaxTotalHistogramBuckets int64

+ func DefaultAggregationLimits() AggregationLimits

type Config

+ Aggregation *AggregationConfig

+ RegistryLimits *RegistryLimits

+ type DecodeLimits struct

+ MaxDecodedBytes int64

+ MaxExpandedSeries int64

+ MaxFamilies int64

+ MaxHistogramBucketsPerSeries int64

+ MaxLabelBytesPerSeries int64

+ MaxLabelsPerSeries int64

+ MaxSeries int64

+ MaxSingleLabelBytes int64

+ MaxStringBytes int64

+ MaxTotalHistogramBuckets int64

+ MaxTotalLabelBytes int64

+ MaxTotalLabels int64

+ MaxWireBytes int64

+ func DefaultDecodeLimits() DecodeLimits

+ type RegistryFamily struct

+ MetricType MetricType

+ Name string

+ Samples []RegistrySample

+ type RegistryHistogram struct

+ Buckets []RegistryHistogramBucket

+ Count uint64

+ Sum float64

+ type RegistryHistogramBucket struct

+ CumulativeCount uint64

+ UpperBound float64

+ type RegistryLimits struct

+ MaxEstimatedStoreBytes int64

+ MaxLabelBytesPerSeries int

+ MaxLabelsPerSeries int

+ MaxSnapshotBytes int64

+ MaxSnapshotSeries int

+ MaxStoredSeries int

+ func DefaultRegistryLimits() RegistryLimits

+ type RegistrySample struct

+ Histogram *RegistryHistogram

+ Labels []SnapshotLabel

+ Value float64

+ type RegistrySnapshot struct

+ CapturedAt time.Time

+ Namespace string

+ SchemaVersion string

+ Subsystem string

+ func DecodeRegistrySnapshot(r io.Reader, limits DecodeLimits) (*RegistrySnapshot, error)

+ func GatherRegistrySnapshot(ctx context.Context) (*RegistrySnapshot, error)

+ func (s *RegistrySnapshot) Families() []RegistryFamily

+ type RegistrySnapshotGatherer interface

+ GatherRegistrySnapshot func(context.Context) (*RegistrySnapshot, error)

+ type SnapshotEmitFunc func(SourceSnapshotResult) error

+ type SnapshotProvider interface

+ GatherSnapshots func(ctx context.Context, emit SnapshotEmitFunc) error

+ Name func() string

+ type SourceDescriptor struct

+ CustomLabels map[string]string

+ InstanceIP string

+ ServiceName string

+ SourceID string

+ type SourceSnapshotResult struct

+ Err error

+ Snapshot *RegistrySnapshot

+ Source SourceDescriptor

v0.2.1

Jul 16, 2026

v0.2.0

Jul 16, 2026

Changes in this version

+ var ErrCollectorLimiterConflict = errors.New("monitor collector already attached to a different series limiter")

+ var ErrDuplicateSeries = errors.New("duplicate metric series")

+ var ErrInvalidLabels = errors.New("invalid prometheus labels")

+ var ErrInvalidMetricName = errors.New("invalid prometheus metric name")

+ var ErrLabelConflict = errors.New("prometheus label conflict")

+ var ErrMalformedHistogram = errors.New("malformed legacy histogram")

+ var ErrManagerStopped = errors.New("monitor manager stopped")

+ var ErrMetricTypeConflict = errors.New("metric family type conflict")

+ var ErrNonMonotonicCounter = errors.New("non-monotonic counter operation")

+ var ErrRemoteWriteBusy = errors.New("remote write already in progress")

+ var ErrReservedMetricName = errors.New("reserved monitor metric name")

+ var ErrRetiredPayloadBusy = errors.New("retired exporter payload is still in use")

+ var ErrSeriesLimit = errors.New("monitor series limit reached")

+ var ErrSnapshotFinished = errors.New("snapshot builder already finished")

+ var ErrSnapshotLimit = errors.New("snapshot byte limit reached")

+ var ErrUnsupportedSummary = errors.New("summary requires structured collector")

+ func TryAddCounter(name string, delta int64) error

+ func TryDecrementLabeledCounter(name string, labels ...string) error

+ func TryIncrementLabeledCounter(name string, labels ...string) error

+ func TrySetLabeledCounter(name string, value float64, labels ...string) error

+ type CheckedCollectorRegistrar interface

+ RegisterCollectorChecked func(collector Collector) error

type Config

+ ErrorHandler func(error)

+ PrometheusExporter *PrometheusExporterConfig

type CounterCollector

+ func (c *CounterCollector) CollectTo(app SnapshotAppender) error

type HistogramCollector

+ func (h *HistogramCollector) CollectTo(app SnapshotAppender) error

type LabeledCounterCollector

+ func (c *LabeledCounterCollector) CollectTo(app SnapshotAppender) error

+ type PrometheusExporterConfig struct

+ IdleTimeout time.Duration

+ ListenAddress string

+ MaxConcurrentScrapes int

+ MaxEstimatedStoreBytes int64

+ MaxLabelBytesPerSeries int

+ MaxLabelsPerSeries int

+ MaxSnapshotBytes int64

+ MaxStoredSeries int

+ Path string

+ ReadHeaderTimeout time.Duration

+ RemoteWriteBatchSeries int

+ ShutdownTimeout time.Duration

+ SnapshotCacheTTL time.Duration

+ WriteTimeout time.Duration

+ type SnapshotAppender interface

+ AppendHistogram func(name string, histogram *dto.Histogram, labels []SnapshotLabel) error

+ AppendScalar func(name string, metricType MetricType, value float64, labels []SnapshotLabel) error

+ type SnapshotCollector interface

+ CollectTo func(SnapshotAppender) error

+ type SnapshotLabel struct

+ Name string

+ Value string

type SystemMetricsCollector

+ func (s *SystemMetricsCollector) CollectTo(app SnapshotAppender) error

v0.1.0

May 26, 2026

Changes in this version

+ func AddCounter(name string, delta int64)

+ func DecrementCounter(name string)

+ func DecrementLabeledCounter(name string, labels ...string)

+ func DeleteLabeledCounter(name string, labels ...string)

+ func ForceWrite() error

+ func GetCounter(name string) int64

+ func GetLabeledCounter(name string, labels ...string) int64

+ func GetOutboundIPv4() (string, error)

+ func GetProcessMemory() (alloc, sys, heapInUse uint64)

+ func GetStatus() map[string]interface

+ func HealthCheck() error

+ func IncrementCounter(name string)

+ func IncrementLabeledCounter(name string, labels ...string)

+ func Init(config Config) error

+ func ObserveHistogram(name string, value float64)

+ func RefreshConnection() error

+ func RegisterCollector(collector Collector) error

+ func RegisterHistogramBuckets(name string, buckets []float64)

+ func RegisterSystemMetricsCollector(logger *zap.Logger) error

+ func SetCounter(name string, value int64)

+ func SetLabeledCounter(name string, value float64, labels ...string)

+ func Shutdown()

+ func TriggerGC()

+ type BaseCollector struct

+ func NewBaseCollector(name string, logger *zap.Logger) BaseCollector

+ func (b *BaseCollector) Name() string

+ type Collector interface

+ Collect func() []Metric

+ Name func() string

+ type Config struct

+ BuildCommit string

+ BuildTime string

+ CustomLabels map[string]string

+ DNSCacheTTL time.Duration

+ DNSDoHEndpoints []string

+ DNSEnable bool

+ DNSRefreshInterval time.Duration

+ DNSTLSServers []string

+ DNSTimeout time.Duration

+ DNSUDPServers []string

+ InstanceIP string

+ Logger *zap.Logger

+ Namespace string

+ RemoteWriteInterval time.Duration

+ RemoteWriteURL string

+ ServiceName string

+ Subsystem string

+ Version string

+ func DefaultConfig() Config

+ type CounterCollector struct

+ func NewCounterCollector(name string, logger *zap.Logger) *CounterCollector

+ func (c *CounterCollector) Add(name string, delta int64)

+ func (c *CounterCollector) Collect() []Metric

+ func (c *CounterCollector) Get(name string) int64

+ func (c *CounterCollector) Inc(name string)

+ func (c *CounterCollector) Set(name string, value int64)

+ type GCStats struct

+ LastGC time.Time

+ NumGC int64

+ PauseTotal time.Duration

+ func ReadGCStats() GCStats

+ type HistogramCollector struct

+ func NewHistogramCollector(name string, logger *zap.Logger) *HistogramCollector

+ func (h *HistogramCollector) Collect() []Metric

+ func (h *HistogramCollector) Observe(name string, value float64)

+ func (h *HistogramCollector) RegisterHistogram(name string, buckets []float64)

+ type LabeledCounterCollector struct

+ func NewApplicationCollector(name string, logger *zap.Logger) *LabeledCounterCollector

+ func NewLabeledCounterCollector(name string, logger *zap.Logger) *LabeledCounterCollector

+ func (c *LabeledCounterCollector) Collect() []Metric

+ func (c *LabeledCounterCollector) Dec(metricName string, labels ...string)

+ func (c *LabeledCounterCollector) Delete(metricName string, labels ...string)

+ func (c *LabeledCounterCollector) ForceCleanup()

+ func (c *LabeledCounterCollector) Get(metricName string, labels ...string) int64

+ func (c *LabeledCounterCollector) Inc(metricName string, labels ...string)

+ func (c *LabeledCounterCollector) Set(metricName string, value float64, labels ...string)

+ func (c *LabeledCounterCollector) SetMaxSeries(n int)

+ func (c *LabeledCounterCollector) SetTTL(ttl time.Duration)

+ type Manager interface

+ GetMetrics func() []Metric

+ RegisterCollector func(collector Collector)

+ Start func() error

+ Stop func()

+ func NewManager(config Config) (Manager, error)

+ type Metric struct

+ Labels map[string]string

+ MetricType MetricType

+ Name string

+ Timestamp time.Time

+ Value float64

+ type MetricType int

+ const Counter

+ const Gauge

+ const Histogram

+ const Summary

+ type SystemMetricsCollector struct

+ func NewSystemMetricsCollector(logger *zap.Logger) *SystemMetricsCollector

+ func (s *SystemMetricsCollector) Collect() []Metric

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