Documentation
¶
Overview ¶
Package observability provides OpenTelemetry tracing and metrics integration.
Usage:
// Full observability (tracing + metrics)
observability.NewObservabilityModule()
// Only tracing (requires config.NewObservabilityConfigModule())
tracing.NewTracingModule()
// Only metrics (requires config.NewObservabilityConfigModule())
metrics.NewMetricsModule()
// Disable observability for tests
observability.NewObservabilityModule(
observability.WithoutTracing(),
observability.WithoutMetrics(),
)
// Disable only tracing
observability.NewObservabilityModule(
observability.WithoutTracing(),
)
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewObservabilityModule ¶
NewObservabilityModule returns fx.Option with full observability: tracing and metrics.
Options:
- WithConfig: provide static observability Config (useful for tests)
- WithoutTracing: disable tracing regardless of configuration
- WithoutMetrics: disable metrics regardless of configuration
Example usage:
// Production - loads config from viper
observability.NewObservabilityModule()
// Testing - disable observability
observability.NewObservabilityModule(
observability.WithoutTracing(),
observability.WithoutMetrics(),
)
Types ¶
type Option ¶ added in v0.4.3
type Option func(*observabilityOptions)
Option is a functional option for configuring the observability module.
func WithConfig ¶ added in v0.4.3
WithConfig provides a static observability Config (useful for tests). When set, the observability configuration will not be loaded from viper.
func WithoutMetrics ¶ added in v0.4.3
func WithoutMetrics() Option
WithoutMetrics disables metrics regardless of configuration. Useful for tests where metrics are not needed.
func WithoutTracing ¶ added in v0.4.3
func WithoutTracing() Option
WithoutTracing disables tracing regardless of configuration. Useful for tests where tracing is not needed.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.