Skip to content

build: make tracing optional #876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 23, 2025
Merged

build: make tracing optional #876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions clash-lib/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ tun = [
redir = []
zero_copy = []
bench = ["dep:criterion"]
tracing = ["tokio/tracing"]
tracing = ["tokio/tracing", "dep:tracing-opentelemetry", "dep:tracing-chrome", "dep:opentelemetry", "dep:opentelemetry-otlp", "dep:opentelemetry_sdk", "dep:opentelemetry-semantic-conventions"]

[dependencies]
# Async
Expand Down Expand Up @@ -73,13 +73,14 @@ anyhow = "1"
# logging
time = { version = "=0.3", features = ["macros", "local-offset"] }
tracing-subscriber = { version = "0.3", features = ["env-filter", "local-time"] }
tracing-appender = "0.2"
tracing-chrome = { version = "0.7" }
opentelemetry = { version = "0.30" }
opentelemetry-otlp = { version = "0.30" }
opentelemetry_sdk = { version = "0.30", features = ["rt-tokio"] }
tracing-opentelemetry = { version = "0.31" }
opentelemetry-semantic-conventions = { version = "0.30", features = ["semconv_experimental"] }
tracing-appender = { version = "0.2"}

tracing-chrome = { version = "0.7", optional = true }
opentelemetry = { version = "0.30", optional = true }
opentelemetry-otlp = { version = "0.30", optional = true }
opentelemetry_sdk = { version = "0.30", optional = true, features = ["rt-tokio"] }
tracing-opentelemetry = { version = "0.31", optional = true }
opentelemetry-semantic-conventions = { version = "0.30", optional = true, features = ["semconv_experimental"] }

# Data structures
url = "2"
Expand Down
92 changes: 59 additions & 33 deletions clash-lib/src/app/logging.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
use crate::def::LogLevel;
use std::{io::IsTerminal, sync::Once};

#[cfg(feature = "tracing")]
use opentelemetry::trace::TracerProvider;
#[cfg(feature = "tracing")]
use opentelemetry_otlp::{Protocol, WithExportConfig};
#[cfg(feature = "tracing")]
use opentelemetry_semantic_conventions::{
SCHEMA_URL,
attribute::{DEPLOYMENT_ENVIRONMENT_NAME, SERVICE_VERSION},
};
use serde::Serialize;
use tokio::sync::broadcast::Sender;
use tracing::level_filters::LevelFilter;
#[cfg(feature = "tracing")]
use tracing_opentelemetry::OpenTelemetryLayer;
#[cfg(target_os = "ios")]
use tracing_oslog::OsLogger;
Expand Down Expand Up @@ -78,9 +82,11 @@ where
}

struct LoggingGuard {
file_appender: Option<tracing_appender::non_blocking::WorkerGuard>,
tracing_chrome: Option<tracing_chrome::FlushGuard>,
tracer_provider: Option<opentelemetry_sdk::trace::SdkTracerProvider>,
_file_appender: Option<tracing_appender::non_blocking::WorkerGuard>,
#[cfg(feature = "tracing")]
_tracing_chrome: Option<tracing_chrome::FlushGuard>,
#[cfg(feature = "tracing")]
_tracer_provider: Option<opentelemetry_sdk::trace::SdkTracerProvider>,
}

static SETUP_LOGGING: Once = Once::new();
Expand Down Expand Up @@ -129,6 +135,8 @@ fn setup_logging_inner(
} else {
(None, None)
};

#[cfg(feature = "tracing")]
let (tracing_chrome, tracing_chrome_g) = if cfg!(feature = "tracing") {
Copy link

Copilot AI Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cfg!(feature = "tracing") runtime check is redundant since this entire block is already behind a #[cfg(feature = "tracing")] compile-time attribute. This condition will always be true when the code is compiled.

Copilot uses AI. Check for mistakes.
let builder = tracing_chrome::ChromeLayerBuilder::new();
let (layer, guard) = builder.build();
Expand All @@ -137,12 +145,14 @@ fn setup_logging_inner(
(None, None)
};

#[cfg(feature = "tracing")]
let exporter = opentelemetry_otlp::SpanExporter::builder()
.with_http()
.with_protocol(Protocol::HttpBinary)
.build()
.unwrap();

#[cfg(feature = "tracing")]
let tracer_provider = opentelemetry_sdk::trace::SdkTracerProvider::builder()
// Customize sampling strategy
.with_sampler(opentelemetry_sdk::trace::Sampler::ParentBased(Box::new(opentelemetry_sdk::trace::Sampler::TraceIdRatioBased(
Expand All @@ -169,6 +179,7 @@ fn setup_logging_inner(
.build())
.with_batch_exporter(exporter)
.build();
#[cfg(feature = "tracing")]
let tracer = tracer_provider.tracer("tracing-otel-subscriber");

let subscriber = tracing_subscriber::registry();
Expand All @@ -190,36 +201,49 @@ fn setup_logging_inner(
"[year repr:last_two]-[month]-[day] [hour]:[minute]:[second]:[subsecond]"
));

let subscriber = subscriber
let log_to_file_layer = appender.map(|x| {
tracing_subscriber::fmt::Layer::new()
.with_span_events(FmtSpan::CLOSE)
.with_timer(timer.clone())
.with_ansi(false)
.compact()
.with_file(true)
.with_line_number(true)
.with_level(true)
.with_writer(x)
.with_filter(exclude.clone())
});
let log_stdout_layer = tracing_subscriber::fmt::Layer::new()
.with_timer(timer)
.with_ansi(std::io::stdout().is_terminal())
.compact()
.with_target(cfg!(debug_assertions))
.with_file(true)
.with_line_number(true)
.with_level(true)
.with_thread_ids(cfg!(debug_assertions))
.with_writer(std::io::stdout)
.with_filter(exclude.clone());

let subscriber = {
#[cfg(feature = "tracing")]
{
subscriber
.with(filter) // Global filter
.with(tracing_chrome)
.with(OpenTelemetryLayer::new(tracer))
.with(collector.with_filter(exclude.clone())) // Log collector for API controller
.with(appender.map(|x| { // Log to file
tracing_subscriber::fmt::Layer::new()
.with_span_events(FmtSpan::CLOSE)
.with_timer(timer.clone())
.with_ansi(false)
.compact()
.with_file(true)
.with_line_number(true)
.with_level(true)
.with_writer(x)
.with_filter(exclude.clone())
}))
.with(// Log to stdout
tracing_subscriber::fmt::Layer::new()
.with_timer(timer)
.with_ansi(std::io::stdout().is_terminal())
.compact()
.with_target(cfg!(debug_assertions))
.with_file(true)
.with_line_number(true)
.with_level(true)
.with_thread_ids(cfg!(debug_assertions))
.with_writer(std::io::stdout)
.with_filter(exclude),
);
.with(collector.with_filter(exclude.clone()))
.with(log_to_file_layer)
.with(log_stdout_layer)
}
#[cfg(not(feature = "tracing"))]
{
subscriber.with(filter) // Global filter
.with(collector.with_filter(exclude.clone()))
.with(log_to_file_layer)
.with(log_stdout_layer)
}
};

#[cfg(target_os = "ios")]
let subscriber =
Expand All @@ -229,9 +253,11 @@ fn setup_logging_inner(
.map_err(|x| anyhow!("setup logging error: {}", x))?;

Ok(Some(LoggingGuard {
file_appender: guard,
tracing_chrome: tracing_chrome_g,
tracer_provider: Some(tracer_provider),
_file_appender: guard,
#[cfg(feature = "tracing")]
_tracing_chrome: tracing_chrome_g,
#[cfg(feature = "tracing")]
_tracer_provider: Some(tracer_provider),
}))
}

Expand Down
Loading