config

package
v0.4.6 Latest Latest
Warning

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

Go to latest
Published: Feb 16, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DefaultMetricsInterval is the default metrics collection interval.
	DefaultMetricsInterval = 10 * time.Second

	// DefaultShutdownTimeout is the default timeout for graceful shutdown.
	DefaultShutdownTimeout = 5 * time.Second

	// DefaultRuntimeStatsInterval is the default interval for runtime stats.
	DefaultRuntimeStatsInterval = 10 * time.Second

	// TracingComponentName is the name used for health check registration.
	TracingComponentName = "tracing"

	// MetricsComponentName is the name used for health check registration.
	MetricsComponentName = "metrics"
)
View Source
const (
	// DefaultSampleRatio is the default sampling ratio (100% for local development).
	DefaultSampleRatio = 1.0
)

Variables

This section is empty.

Functions

func NewObservabilityConfigModule

func NewObservabilityConfigModule(opts ...Option) fx.Option

NewObservabilityConfigModule provides observability configuration. By default, configuration is loaded from viper. Use WithConfig for static config (useful for tests).

Types

type Config

type Config struct {
	OtelCollectorEndpoint string        `mapstructure:"otel-collector-endpoint"`
	Tracing               TracingConfig `mapstructure:"tracing"`
	Metrics               MetricsConfig `mapstructure:"metrics"`
}

Config holds all observability configuration.

type MetricsConfig

type MetricsConfig struct {
	Enabled  bool          `mapstructure:"enabled"`
	Interval time.Duration `mapstructure:"interval"`
}

MetricsConfig holds metrics-specific configuration.

type Option added in v0.4.3

type Option func(*configOptions)

Option is a functional option for configuring the observability config module.

func WithConfig added in v0.4.3

func WithConfig(cfg Config) Option

WithConfig provides a static Config (useful for tests).

func WithDisableMetrics added in v0.4.3

func WithDisableMetrics() Option

WithDisableMetrics disables metrics regardless of configuration.

func WithDisableTracing added in v0.4.3

func WithDisableTracing() Option

WithDisableTracing disables tracing regardless of configuration.

type TracingConfig

type TracingConfig struct {
	Enabled     bool    `mapstructure:"enabled"`
	SampleRatio float64 `mapstructure:"sample-ratio"`
}

TracingConfig holds tracing-specific configuration.

Jump to

Keyboard shortcuts

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