Move tokio-console setup to CLI

Author: shuheiktgw

quickwit/Cargo.lock

@@ -26,6 +26,7 @@ bytesize = { workspace = true }
 chrono = { workspace = true }
 clap = { workspace = true }
 colored = { workspace = true }
+console-subscriber = { workspace = true, optional = true }
 dialoguer = { workspace = true }
 futures = { workspace = true }
 humantime = { workspace = true }
@@ -91,8 +92,8 @@ openssl-support = ["openssl-probe"]
 metrics = [ "quickwit-indexing/metrics" ]
 # Requires to enable tokio unstable via RUSTFLAGS="--cfg tokio_unstable"
 tokio-console = [
+  "dep:console-subscriber",
   "quickwit-common/named_tasks",
-  "quickwit-telemetry-exporters/tokio-console",
 ]
 release-feature-set = [
   "jemalloc",

quickwit/quickwit-cli/Cargo.toml

@@ -26,6 +26,9 @@ use quickwit_common::runtimes::scrape_tokio_runtime_metrics;
 use quickwit_serve::BuildInfo;
 use tracing::error;
 
+#[cfg(feature = "tokio-console")]
+const QW_ENABLE_TOKIO_CONSOLE_ENV_KEY: &str = "QW_ENABLE_TOKIO_CONSOLE";
+
 /// The main tokio runtime takes num_cores / 3 threads by default, and can be overridden by the
 /// QW_RUNTIME_NUM_THREADS environment variable.
 fn get_main_runtime_num_threads() -> usize {
@@ -76,13 +79,28 @@ fn parse_cli_command() -> (CliCommand, bool) {
     (command, ansi_colors)
 }
 
+fn init_telemetry(
+    service_version: &str,
+    level: tracing::Level,
+    ansi_colors: bool,
+) -> anyhow::Result<quickwit_telemetry_exporters::TelemetryHandle> {
+    #[cfg(feature = "tokio-console")]
+    {
+        if quickwit_common::get_bool_from_env(QW_ENABLE_TOKIO_CONSOLE_ENV_KEY, false) {
+            console_subscriber::init();
+            return Ok(quickwit_telemetry_exporters::TelemetryHandle::default());
+        }
+    }
+    quickwit_telemetry_exporters::init_telemetry(service_version, level, ansi_colors)
+}
+
 async fn main_impl() -> anyhow::Result<()> {
     let (command, ansi_colors) = parse_cli_command();
 
     install_default_crypto_ring_provider();
 
     let build_info = BuildInfo::get();
-    let telemetry_handle = quickwit_telemetry_exporters::init_telemetry(
+    let telemetry_handle = init_telemetry(
         &build_info.version,
         command.default_log_level(),
         ansi_colors,

quickwit/quickwit-cli/src/main.rs

@@ -13,7 +13,6 @@ license.workspace = true
 [dependencies]
 anyhow = { workspace = true }
 backtrace = { workspace = true, optional = true }
-console-subscriber = { workspace = true, optional = true }
 metrics = { workspace = true }
 metrics-exporter-otel = { workspace = true }
 metrics-exporter-prometheus = { workspace = true }
@@ -36,8 +35,3 @@ jemalloc-profiled = [
   "dep:backtrace",
   "quickwit-common/jemalloc-profiled",
 ]
-# Requires to enable tokio unstable via RUSTFLAGS="--cfg tokio_unstable"
-tokio-console = [
-  "dep:console-subscriber",
-  "quickwit-common/named_tasks",
-]

quickwit/quickwit-telemetry-exporters/Cargo.toml

@@ -24,8 +24,6 @@ use opentelemetry_sdk::logs::SdkLoggerProvider;
 use opentelemetry_sdk::metrics::SdkMeterProvider as SdkMetricsProvider;
 use opentelemetry_sdk::propagation::TraceContextPropagator;
 use opentelemetry_sdk::trace::SdkTracerProvider;
-#[cfg(feature = "tokio-console")]
-use quickwit_common::get_bool_from_env;
 use tracing::Level;
 use tracing_subscriber::EnvFilter;
 use tracing_subscriber::layer::SubscriberExt;
@@ -36,9 +34,6 @@ mod metrics;
 mod otlp;
 pub mod prometheus;
 
-#[cfg(feature = "tokio-console")]
-const QW_ENABLE_TOKIO_CONSOLE_ENV_KEY: &str = "QW_ENABLE_TOKIO_CONSOLE";
-
 pub type EnvFilterReloadFn = Arc<dyn Fn(&str) -> anyhow::Result<()> + Send + Sync>;
 
 pub fn do_nothing_env_filter_reload_fn() -> EnvFilterReloadFn {
@@ -52,6 +47,17 @@ pub struct TelemetryHandle {
     meter_provider: Option<SdkMetricsProvider>,
 }
 
+impl Default for TelemetryHandle {
+    fn default() -> Self {
+        TelemetryHandle {
+            env_filter_reload_fn: do_nothing_env_filter_reload_fn(),
+            tracer_provider: None,
+            logger_provider: None,
+            meter_provider: None,
+        }
+    }
+}
+
 impl TelemetryHandle {
     pub fn env_filter_reload_fn(&self) -> EnvFilterReloadFn {
         self.env_filter_reload_fn.clone()
@@ -104,18 +110,6 @@ pub fn init_telemetry(
 
     let meter_provider = metrics::init_metrics_provider(service_version, &otlp_config)?;
 
-    #[cfg(feature = "tokio-console")]
-    {
-        if get_bool_from_env(QW_ENABLE_TOKIO_CONSOLE_ENV_KEY, false) {
-            console_subscriber::init();
-            return Ok(TelemetryHandle {
-                env_filter_reload_fn: do_nothing_env_filter_reload_fn(),
-                tracer_provider: None,
-                logger_provider: None,
-                meter_provider,
-            });
-        }
-    }
     global::set_text_map_propagator(TraceContextPropagator::new());
 
     let event_format = logs::EventFormat::get_from_env();