Crate near_o11y

Observability (o11y) helpers for the NEAR codebase.

This crate contains all sorts of utilities to enable a more convenient observability implementation in the NEAR codebase.

The are three infrastructures:

• tracing, for structured, hierarchical logging of events (see default_subscriber function function in particular)
• metrics – convenience wrappers around prometheus metric, for reporting statistics.
• io-tracer – custom infrastructure for observing DB accesses in particular (mostly for parameter estimator)

Re-exports

• pub use tracing;
• pub use tracing_appender;
• pub use tracing_subscriber;
• pub use context::*;

Modules

• context
  Custom tracing subscriber implementation that produces IO traces.
• log_config
• macros
• metrics
  A fork of the lighthouse_metrics crate used to implement prometheus
• pretty
• testonly

Macros

• handler_debug_span
  A macro that lets attach handle() functions to the tracing context that generated the actix message being processed. Creates a DEBUG-level span with the handler type name and the message type name as attributes.
• handler_span
  Internal use only.
• handler_trace_span
  A macro that lets attach handle() functions to the tracing context that generated the actix message being processed. Creates a TRACE-level span with the handler type name and the message type name as attributes.
• io_trace
• log_assert
  Asserts that the condition is true, logging an error otherwise.

Structs

• DefaultSubscriberGuard
  The resource representing a registered subscriber.
• EnvFilterBuilder
• Options
  Configures exporter of span and trace data.

Enums

• BuildEnvFilterError
• ColorOutput
  Whether to use colored log format. Option Auto enables color output only if the logging is done to a terminal and NO_COLOR environment variable is not set.
• OpenTelemetryLevel
• ReloadError

Constants

• DEFAULT_RUST_LOG
  The default value for the RUST_LOG environment variable if one isn’t specified otherwise.

Traits

• OpenTelemetrySpanExt
  Utility functions to allow tracing Spans to accept and return OpenTelemetry Contexts.

Functions

• default_subscriber
  Constructs a subscriber set to the option appropriate for the NEAR code.
• default_subscriber_with_opentelemetry
  Constructs a subscriber set to the option appropriate for the NEAR code.
• get_opentelemetry_filter
• print_backtrace
  Prints backtrace to stderr.
• reload
  Constructs new filters for the logging and opentelemetry layers.
• reload_log_config
• set_default_otlp_level