Skip to main content

Module observability

Module observability 

Source
Expand description

Observability and telemetry.

Modulesยง

event_bus ๐Ÿ”’
Tokio broadcast event bus for cross-component notifications.
logging ๐Ÿ”’
Structured logging.
metrics ๐Ÿ”’
Prometheus metrics.
otlp ๐Ÿ”’
OTLP exporter configuration.
request_context ๐Ÿ”’
Request context propagation for correlation IDs.
tracing ๐Ÿ”’
Distributed tracing and OTLP logging.

Structsยง

EventBus
Central event bus for broadcasting memory events.
InitOptions
Options for environment-based initialization.
LogFileWriter ๐Ÿ”’
Thread-safe file writer for logging.
Logger
Logger for structured logging.
LoggingConfig
Logging configuration.
Metrics
Metrics collector.
MetricsConfig
Metrics configuration.
ObservabilityConfig
Full observability configuration.
ObservabilityHandle
Handle for observability runtime components.
OtlpConfig
OTLP exporter configuration.
OtlpExporter
OpenTelemetry Protocol exporter.
RequestContext
Per-request context with correlation ID.
Tracer
Tracer for distributed tracing.
TracingConfig
Tracing configuration.

Enumsยง

LogFormat
Logging output format.
OtlpProtocol
OTLP transport protocol.

Staticsยง

OBSERVABILITY_INIT ๐Ÿ”’

Traitsยง

ShutdownProvider ๐Ÿ”’
Trait for providers that can be shut down.

Functionsยง

build_config ๐Ÿ”’
current_request_id
Returns the current request ID, if set.
enter_request_context
Enters a request context for synchronous flows.
flush_metrics
Flushes metrics to the push gateway if configured.
global_event_bus
Returns the global event bus, initializing it on first use.
init
Initializes logging, tracing, and metrics for the process.
init_error ๐Ÿ”’
Helper to convert init errors.
init_from_config
Initializes observability from config settings with env overrides.
init_from_env
Initializes observability using environment variables.
open_log_file ๐Ÿ”’
Opens a log file for appending.
scope_request_context
Scopes a request context across an async future.
set_instance_label
Sets the metrics instance label for push gateway grouping.