Function configure

src/ore/src/tracing.rs:323–591

(config: TracingConfig<F>)

// context, hence the `async`.
#[allow(clippy::unused_async)]
pub async fn configure<F>(config: TracingConfig<F>) -> Result<TracingHandle, anyhow::Error>
where
    F: Fn(&tracing::Metadata<'_>) -> sentry_tracing::EventFilter + Send + Sync + 'static,
{
    let stderr_log_layer: Box<dyn Layer<Registry> + Send + Sync> = match config.stderr_log.format {
        StderrLogFormat::Text { prefix } => {
            // See: https://no-color.org/
            let no_color = std::env::var_os("NO_COLOR").unwrap_or_else(|| "".into()) != "";
            Box::new(
                fmt::layer()
                    .with_writer(io::stderr)
                    .event_format(PrefixFormat {
                        inner: format(),
                        prefix,
                    })
                    .with_ansi(!no_color && io::stderr().is_terminal()),
            )
        }
        StderrLogFormat::Json => Box::new(
            fmt::layer()
                .with_writer(io::stderr)
                .json()
                .with_current_span(true),
        ),
    };
    let (stderr_log_filter, stderr_log_filter_reloader) = reload::Layer::new({
        let mut filter = config.stderr_log.filter;
        for directive in LOGGING_DEFAULTS.iter() {
            filter = filter.add_directive(directive.clone());
        }
        filter
    });
    // Add rate limiting for OpenTelemetry internal logs to prevent log spam
    // when there are issues with the OpenTelemetry pipeline (e.g., channel full,
    // connection errors). This only affects logs from "opentelemetry*" targets.
    let otel_rate_limit_filter = OpenTelemetryRateLimitingFilter::new(Duration::from_secs(
        OPENTELEMETRY_RATE_LIMIT_BACKOFF_SECS,
    ));
    // IMPORTANT: The order matters here. The outer filter's `max_level_hint()` is used
    // to determine the global tracing level. The `otel_rate_limit_filter` doesn't provide
    // a `max_level_hint()` (defaults to TRACE), so the `stderr_log_filter` (EnvFilter)
    // must be the outer filter to ensure the correct max level is reported.
    let stderr_log_layer = stderr_log_layer
        .with_filter(otel_rate_limit_filter)
        .with_filter(stderr_log_filter);
    let stderr_log_reloader = Arc::new(move |mut filter: EnvFilter, defaults: Vec<Directive>| {
        for directive in &defaults {
            filter = filter.add_directive(directive.clone());
        }
        Ok(stderr_log_filter_reloader.reload(filter)?)
    });

    let (otel_layer, otel_reloader): (_, Reloader) = if let Some(otel_config) = config.opentelemetry
    {
        opentelemetry::global::set_text_map_propagator(TraceContextPropagator::new());

        // Manually set up an OpenSSL-backed, h2, proxied `Channel`,
        // with the timeout configured according to: