extract logging config into subcrate

Author: syphar

Cargo.lock

@@ -29,15 +29,17 @@ opentelemetry-otlp = { version = "0.31.0", features = ["grpc-tonic",  "metrics"]
 opentelemetry-resource-detectors = "0.10.0"
 opentelemetry_sdk = { version = "0.31.0", features = ["rt-tokio"] }
 regex = "1"
+sentry = { version = "0.46.0", features = ["panic", "tracing", "tower-http", "anyhow", "backtrace"] }
 tokio = { version = "1.0", features = ["rt-multi-thread", "signal", "macros", "process", "sync"] }
 tracing = "0.1.37"
 url = { version = "2.1.1", features = ["serde"] }
 
 [dependencies]
 docs_rs_env_vars = { path = "crates/lib/docs_rs_env_vars" }
+docs_rs_logging = { path = "crates/lib/docs_rs_logging" }
 docs_rs_opentelemetry = { path = "crates/lib/docs_rs_opentelemetry" }
 docs_rs_utils = { path = "crates/lib/docs_rs_utils" }
-sentry = { version = "0.46.0", features = ["panic", "tracing", "tower-http", "anyhow", "backtrace"] }
+sentry = { workspace = true }
 log = "0.4"
 tracing = { workspace = true }
 tracing-subscriber = { version = "0.3.20", default-features = false, features = ["ansi", "fmt", "json", "env-filter", "tracing-log"] }

Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "docs_rs_logging"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+anyhow = { workspace = true }
+docs_rs_utils = { path = "../docs_rs_utils" }
+sentry = { workspace = true }
+tracing = { workspace = true }
+tracing-subscriber = { version = "0.3.20", default-features = false, features = ["ansi", "fmt", "json", "env-filter", "tracing-log"] }

crates/lib/docs_rs_logging/Cargo.toml

@@ -0,0 +1,79 @@
+use sentry::{
+    TransactionContext, integrations::panic as sentry_panic,
+    integrations::tracing as sentry_tracing,
+};
+use std::{env, str::FromStr as _, sync::Arc};
+use tracing_subscriber::{EnvFilter, filter::Directive, prelude::*};
+
+pub struct Guard {
+    #[allow(dead_code)]
+    sentry_guard: Option<sentry::ClientInitGuard>,
+}
+
+pub fn init() -> anyhow::Result<Guard> {
+    let log_formatter = {
+        let log_format = env::var("DOCSRS_LOG_FORMAT").unwrap_or_default();
+
+        if log_format == "json" {
+            tracing_subscriber::fmt::layer().json().boxed()
+        } else {
+            tracing_subscriber::fmt::layer().boxed()
+        }
+    };
+
+    let tracing_registry = tracing_subscriber::registry().with(log_formatter).with(
+        EnvFilter::builder()
+            .with_default_directive(Directive::from_str("docs_rs=info")?)
+            .with_env_var("DOCSRS_LOG")
+            .from_env_lossy(),
+    );
+
+    let sentry_guard = if let Ok(sentry_dsn) = env::var("SENTRY_DSN") {
+        tracing::subscriber::set_global_default(tracing_registry.with(
+            sentry_tracing::layer().event_filter(|md| {
+                if md.fields().field("reported_to_sentry").is_some() {
+                    sentry_tracing::EventFilter::Ignore
+                } else {
+                    sentry_tracing::default_event_filter(md)
+                }
+            }),
+        ))?;
+
+        let traces_sample_rate = env::var("SENTRY_TRACES_SAMPLE_RATE")
+            .ok()
+            .and_then(|v| v.parse().ok())
+            .unwrap_or(0.0);
+
+        let traces_sampler = move |ctx: &TransactionContext| -> f32 {
+            if let Some(sampled) = ctx.sampled() {
+                // if the transaction was already marked as "to be sampled" by
+                // the JS/frontend SDK, we want to sample it in the backend too.
+                return if sampled { 1.0 } else { 0.0 };
+            }
+
+            let op = ctx.operation();
+            if op == "docbuilder.build_package" {
+                // record all transactions for builds
+                1.
+            } else {
+                traces_sample_rate
+            }
+        };
+
+        Some(sentry::init((
+            sentry_dsn,
+            sentry::ClientOptions {
+                release: Some(docs_rs_utils::BUILD_VERSION.into()),
+                attach_stacktrace: true,
+                traces_sampler: Some(Arc::new(traces_sampler)),
+                ..Default::default()
+            }
+            .add_integration(sentry_panic::PanicIntegration::default()),
+        )))
+    } else {
+        tracing::subscriber::set_global_default(tracing_registry)?;
+        None
+    };
+
+    Ok(Guard { sentry_guard })
+}

crates/lib/docs_rs_logging/src/lib.rs

@@ -12,84 +12,16 @@ use docs_rs::{
     },
 };
 use futures_util::StreamExt;
-use sentry::{
-    TransactionContext, integrations::panic as sentry_panic,
-    integrations::tracing as sentry_tracing,
-};
-use std::{env, fmt::Write, net::SocketAddr, path::PathBuf, str::FromStr, sync::Arc};
+use std::{env, fmt::Write, net::SocketAddr, path::PathBuf, sync::Arc};
 use tokio::runtime;
 use tracing_log::LogTracer;
-use tracing_subscriber::{EnvFilter, filter::Directive, prelude::*};
 
 fn main() {
     // set the global log::logger for backwards compatibility
     // through rustwide.
     rustwide::logging::init_with(LogTracer::new());
 
-    let log_formatter = {
-        let log_format = env::var("DOCSRS_LOG_FORMAT").unwrap_or_default();
-
-        if log_format == "json" {
-            tracing_subscriber::fmt::layer().json().boxed()
-        } else {
-            tracing_subscriber::fmt::layer().boxed()
-        }
-    };
-
-    let tracing_registry = tracing_subscriber::registry().with(log_formatter).with(
-        EnvFilter::builder()
-            .with_default_directive(Directive::from_str("docs_rs=info").unwrap())
-            .with_env_var("DOCSRS_LOG")
-            .from_env_lossy(),
-    );
-
-    let _sentry_guard = if let Ok(sentry_dsn) = env::var("SENTRY_DSN") {
-        tracing::subscriber::set_global_default(tracing_registry.with(
-            sentry_tracing::layer().event_filter(|md| {
-                if md.fields().field("reported_to_sentry").is_some() {
-                    sentry_tracing::EventFilter::Ignore
-                } else {
-                    sentry_tracing::default_event_filter(md)
-                }
-            }),
-        ))
-        .unwrap();
-
-        let traces_sample_rate = env::var("SENTRY_TRACES_SAMPLE_RATE")
-            .ok()
-            .and_then(|v| v.parse().ok())
-            .unwrap_or(0.0);
-
-        let traces_sampler = move |ctx: &TransactionContext| -> f32 {
-            if let Some(sampled) = ctx.sampled() {
-                // if the transaction was already marked as "to be sampled" by
-                // the JS/frontend SDK, we want to sample it in the backend too.
-                return if sampled { 1.0 } else { 0.0 };
-            }
-
-            let op = ctx.operation();
-            if op == "docbuilder.build_package" {
-                // record all transactions for builds
-                1.
-            } else {
-                traces_sample_rate
-            }
-        };
-
-        Some(sentry::init((
-            sentry_dsn,
-            sentry::ClientOptions {
-                release: Some(docs_rs::BUILD_VERSION.into()),
-                attach_stacktrace: true,
-                traces_sampler: Some(Arc::new(traces_sampler)),
-                ..Default::default()
-            }
-            .add_integration(sentry_panic::PanicIntegration::default()),
-        )))
-    } else {
-        tracing::subscriber::set_global_default(tracing_registry).unwrap();
-        None
-    };
+    let guard = docs_rs_logging::init().expect("error initializing logging");
 
     if let Err(err) = CommandLine::parse().handle_args() {
         let mut msg = format!("Error: {err}");
@@ -106,7 +38,7 @@ fn main() {
         // we need to drop the sentry guard here so all unsent
         // errors are sent to sentry before
         // process::exit kills everything.
-        drop(_sentry_guard);
+        drop(guard);
         std::process::exit(1);
     }
 }