fix: remove zenoh_util from examples

Users should not use `zenoh_util::try_init_log_from_env`. They should instead register their own subscriber with their own formatting preferences. Examples provides a basic logging initialization that users can copy-paste if they don't want to learn tracing.
eclipse-zenoh · May 31, 2024 · d854939 · d854939
1 parent 1cb33c0
commit d854939
Show file tree

Hide file tree

Showing 28 changed files with 187 additions and 54 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -34,13 +34,13 @@ transport_unixpipe = ["zenoh/transport_unixpipe"]
 [dependencies]
 tokio = { workspace = true, features = ["rt-multi-thread", "time", "io-std"] }
 clap = { workspace = true, features = ["derive"] }
-zenoh-util = { workspace = true }
 flume = { workspace = true }
 futures = { workspace = true }
 git-version = { workspace = true }
 json5 = { workspace = true }
 zenoh-collections = { workspace = true }
 tracing = { workspace = true }
+tracing-subscriber = { workspace = true }
 zenoh = { workspace = true, default-features = true }
 zenoh-ext = { workspace = true }
 

diff --git a/examples/examples/z_alloc_shm.rs b/examples/examples/z_alloc_shm.rs
@@ -22,8 +22,8 @@ use zenoh::{
 
 #[tokio::main]
 async fn main() {
-    // Initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
+
     run().await.unwrap()
 }
 
@@ -144,3 +144,9 @@ async fn run() -> ZResult<()> {
     // Publish SHM buffer
     publisher.put(sbuf).await
 }
+
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
diff --git a/examples/examples/z_delete.rs b/examples/examples/z_delete.rs
@@ -17,8 +17,7 @@ use zenoh_examples::CommonArgs;
 
 #[tokio::main]
 async fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (config, key_expr) = parse_args();
 
@@ -31,6 +30,12 @@ async fn main() {
     session.close().await.unwrap();
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::Parser, Clone, PartialEq, Eq, Hash, Debug)]
 struct Args {
     #[arg(short, long, default_value = "demo/example/zenoh-rs-put")]

diff --git a/examples/examples/z_forward.rs b/examples/examples/z_forward.rs
@@ -18,8 +18,7 @@ use zenoh_ext::SubscriberForward;
 
 #[tokio::main]
 async fn main() {
-    // Initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (config, key_expr, forward) = parse_args();
 
@@ -34,6 +33,12 @@ async fn main() {
     subscriber.forward(publisher).await.unwrap();
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::Parser, Clone, PartialEq, Eq, Hash, Debug)]
 struct Args {
     #[arg(short, long, default_value = "demo/example/**")]

diff --git a/examples/examples/z_get.rs b/examples/examples/z_get.rs
@@ -19,8 +19,7 @@ use zenoh_examples::CommonArgs;
 
 #[tokio::main]
 async fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (config, selector, value, target, timeout) = parse_args();
 
@@ -63,6 +62,12 @@ async fn main() {
     }
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::ValueEnum, Clone, Copy, Debug)]
 #[value(rename_all = "SCREAMING_SNAKE_CASE")]
 enum Qt {

diff --git a/examples/examples/z_get_liveliness.rs b/examples/examples/z_get_liveliness.rs
@@ -19,8 +19,7 @@ use zenoh_examples::CommonArgs;
 
 #[tokio::main]
 async fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (config, key_expr, timeout) = parse_args();
 
@@ -48,6 +47,12 @@ async fn main() {
     }
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(Parser, Clone, Debug)]
 struct Args {
     #[arg(short, long, default_value = "group1/**")]

diff --git a/examples/examples/z_get_shm.rs b/examples/examples/z_get_shm.rs
@@ -30,8 +30,7 @@ const N: usize = 10;
 
 #[tokio::main]
 async fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (mut config, selector, mut value, target, timeout) = parse_args();
 
@@ -101,6 +100,12 @@ async fn main() {
     }
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::ValueEnum, Clone, Copy, Debug)]
 #[value(rename_all = "SCREAMING_SNAKE_CASE")]
 enum Qt {

diff --git a/examples/examples/z_info.rs b/examples/examples/z_info.rs
@@ -17,8 +17,7 @@ use zenoh_examples::CommonArgs;
 
 #[tokio::main]
 async fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let config = parse_args();
 
@@ -37,6 +36,12 @@ async fn main() {
     );
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::Parser, Clone, PartialEq, Eq, Hash, Debug)]
 struct Args {
     #[command(flatten)]

diff --git a/examples/examples/z_liveliness.rs b/examples/examples/z_liveliness.rs
@@ -17,8 +17,7 @@ use zenoh_examples::CommonArgs;
 
 #[tokio::main]
 async fn main() {
-    // Initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (config, key_expr) = parse_args();
 
@@ -38,6 +37,12 @@ async fn main() {
     };
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::Parser, Clone, PartialEq, Eq, Hash, Debug)]
 struct Args {
     #[arg(short, long, default_value = "group1/zenoh-rs")]

diff --git a/examples/examples/z_ping.rs b/examples/examples/z_ping.rs
@@ -18,8 +18,7 @@ use zenoh::{bytes::ZBytes, key_expr::keyexpr, prelude::*, publisher::CongestionC
 use zenoh_examples::CommonArgs;
 
 fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (config, warmup, size, n, express) = parse_args();
     let session = zenoh::open(config).wait().unwrap();
@@ -76,6 +75,12 @@ fn main() {
     }
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(Parser)]
 struct Args {
     /// express for sending data

diff --git a/examples/examples/z_ping_shm.rs b/examples/examples/z_ping_shm.rs
@@ -25,8 +25,7 @@ use zenoh::{
 use zenoh_examples::CommonArgs;
 
 fn main() {
-    // Initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (mut config, warmup, size, n) = parse_args();
 
@@ -102,6 +101,12 @@ fn main() {
     }
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(Parser)]
 struct Args {
     #[arg(short, long, default_value = "1")]

diff --git a/examples/examples/z_pong.rs b/examples/examples/z_pong.rs
@@ -16,8 +16,7 @@ use zenoh::{key_expr::keyexpr, prelude::*, publisher::CongestionControl, Config}
 use zenoh_examples::CommonArgs;
 
 fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (mut config, express) = parse_args();
 
@@ -49,6 +48,12 @@ fn main() {
     std::thread::park();
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::Parser, Clone, PartialEq, Eq, Hash, Debug)]
 struct Args {
     /// express for sending data

diff --git a/examples/examples/z_pub.rs b/examples/examples/z_pub.rs
@@ -19,8 +19,7 @@ use zenoh_examples::CommonArgs;
 
 #[tokio::main]
 async fn main() {
-    // Initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (config, key_expr, value, attachment) = parse_args();
 
@@ -39,6 +38,12 @@ async fn main() {
     }
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::Parser, Clone, PartialEq, Eq, Hash, Debug)]
 struct Args {
     #[arg(short, long, default_value = "demo/example/zenoh-rs-pub")]

diff --git a/examples/examples/z_pub_shm.rs b/examples/examples/z_pub_shm.rs
@@ -27,8 +27,7 @@ const N: usize = 10;
 
 #[tokio::main]
 async fn main() -> Result<(), ZError> {
-    // Initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (mut config, path, value) = parse_args();
 
@@ -92,6 +91,12 @@ async fn main() -> Result<(), ZError> {
     Ok(())
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::Parser, Clone, PartialEq, Eq, Hash, Debug)]
 struct Args {
     #[arg(short, long, default_value = "demo/example/zenoh-rs-pub")]

diff --git a/examples/examples/z_pub_shm_thr.rs b/examples/examples/z_pub_shm_thr.rs
@@ -23,8 +23,8 @@ use zenoh_examples::CommonArgs;
 
 #[tokio::main]
 async fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
+
     let (mut config, sm_size, size) = parse_args();
 
     // A probing procedure for shared memory is performed upon session opening. To enable `z_pub_shm_thr` to operate
@@ -71,6 +71,12 @@ async fn main() {
     }
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::Parser, Clone, PartialEq, Eq, Hash, Debug)]
 struct Args {
     #[arg(short, long, default_value = "32")]

diff --git a/examples/examples/z_pub_thr.rs b/examples/examples/z_pub_thr.rs
@@ -23,8 +23,8 @@ use zenoh::{
 use zenoh_examples::CommonArgs;
 
 fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
+
     let args = Args::parse();
 
     let mut prio = Priority::DEFAULT;
@@ -68,6 +68,12 @@ fn main() {
     }
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(Parser, Clone, PartialEq, Eq, Hash, Debug)]
 struct Args {
     /// express for sending data

diff --git a/examples/examples/z_pull.rs b/examples/examples/z_pull.rs
@@ -19,8 +19,7 @@ use zenoh_examples::CommonArgs;
 
 #[tokio::main]
 async fn main() {
-    // initiate logging
-    zenoh_util::try_init_log_from_env();
+    initialize_logging();
 
     let (config, key_expr, size, interval) = parse_args();
 
@@ -91,6 +90,12 @@ async fn main() {
     // }
 }
 
+fn initialize_logging() {
+    tracing_subscriber::fmt()
+        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
+        .init()
+}
+
 #[derive(clap::Parser, Clone, PartialEq, Debug)]
 struct SubArgs {
     #[arg(short, long, default_value = "demo/example/**")]