Merge pull request #215 from DenisBiryukov91/align-logging

align logging with zenoh-c
eclipse-zenoh · Sep 13, 2024 · 0094b57 · 0094b57
2 parents c25dbcd + 5908c96
commit 0094b57
Show file tree

Hide file tree

Showing 35 changed files with 109 additions and 8 deletions.
diff --git a/docs/commons.rst b/docs/commons.rst
@@ -79,4 +79,5 @@ Sample
 Logging
 -------
 
-.. doxygenfunction:: init_logging
+.. doxygenfunction:: try_init_log_from_env
+.. doxygenfunction:: init_log_from_env_or
diff --git a/examples/simple/universal/z_simple.cxx b/examples/simple/universal/z_simple.cxx
@@ -162,6 +162,9 @@ class CustomSubscriber {
 
 int main(int, char**) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         Config config = Config::create_default();
         auto session = Session::open(std::move(config));
 

diff --git a/examples/simple/zenohc/zc_simple.cxx b/examples/simple/zenohc/zc_simple.cxx
@@ -18,6 +18,7 @@
 using namespace zenoh;
 
 int main(int, char **) {
+    init_log_from_env_or("error");
     Config config = Config::create_default();
     auto session = Session::open(std::move(config));
     session.put("demo/example/simple", "Simple!");

diff --git a/examples/universal/z_delete.cxx b/examples/universal/z_delete.cxx
@@ -71,6 +71,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_get.cxx b/examples/universal/z_get.cxx
@@ -103,6 +103,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_get_attachment.cxx b/examples/universal/z_get_attachment.cxx
@@ -98,6 +98,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_get_channel.cxx b/examples/universal/z_get_channel.cxx
@@ -83,6 +83,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_get_channel_non_blocking.cxx b/examples/universal/z_get_channel_non_blocking.cxx
@@ -97,6 +97,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_info.cxx b/examples/universal/z_info.cxx
@@ -73,6 +73,9 @@ int _main(int argc, char** argv) {
 
 int main(int argc, char** argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         return _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_ping.cxx b/examples/universal/z_ping.cxx
@@ -142,6 +142,9 @@ struct args_t parse_args(int argc, char** argv) {
 
 int main(int argc, char** argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         return _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_pong.cxx b/examples/universal/z_pong.cxx
@@ -36,6 +36,9 @@ int _main(int, char **) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_pub.cxx b/examples/universal/z_pub.cxx
@@ -101,6 +101,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_pub_attachment.cxx b/examples/universal/z_pub_attachment.cxx
@@ -90,6 +90,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_pub_delete.cxx b/examples/universal/z_pub_delete.cxx
@@ -76,6 +76,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_pub_thr.cxx b/examples/universal/z_pub_thr.cxx
@@ -81,6 +81,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_put.cxx b/examples/universal/z_put.cxx
@@ -88,6 +88,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_queryable.cxx b/examples/universal/z_queryable.cxx
@@ -106,6 +106,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_queryable_attachment.cxx b/examples/universal/z_queryable_attachment.cxx
@@ -101,6 +101,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_scout.cxx b/examples/universal/z_scout.cxx
@@ -111,6 +111,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_sub.cxx b/examples/universal/z_sub.cxx
@@ -97,6 +97,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_sub_attachment.cxx b/examples/universal/z_sub_attachment.cxx
@@ -85,6 +85,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/universal/z_sub_thr.cxx b/examples/universal/z_sub_thr.cxx
@@ -122,6 +122,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/zenohc/z_get_liveliness.cxx b/examples/zenohc/z_get_liveliness.cxx
@@ -79,6 +79,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/zenohc/z_get_shm.cxx b/examples/zenohc/z_get_shm.cxx
@@ -94,6 +94,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/zenohc/z_liveliness.cxx b/examples/zenohc/z_liveliness.cxx
@@ -68,6 +68,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/zenohc/z_ping_shm.cxx b/examples/zenohc/z_ping_shm.cxx
@@ -147,6 +147,9 @@ struct args_t parse_args(int argc, char** argv) {
 
 int main(int argc, char** argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         return _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/zenohc/z_pub_shm.cxx b/examples/zenohc/z_pub_shm.cxx
@@ -87,6 +87,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/zenohc/z_pub_shm_thr.cxx b/examples/zenohc/z_pub_shm_thr.cxx
@@ -68,6 +68,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/zenohc/z_queryable_shm.cxx b/examples/zenohc/z_queryable_shm.cxx
@@ -105,6 +105,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/zenohc/z_sub_liveliness.cxx b/examples/zenohc/z_sub_liveliness.cxx
@@ -75,6 +75,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/examples/zenohc/z_sub_shm.cxx b/examples/zenohc/z_sub_shm.cxx
@@ -107,6 +107,9 @@ int _main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
     try {
+#ifdef ZENOHCXX_ZENOHC
+        init_log_from_env_or("error");
+#endif
         _main(argc, argv);
     } catch (ZException e) {
         std::cout << "Received an error :" << e.what() << "\n";

diff --git a/include/zenoh/api/logging.hxx b/include/zenoh/api/logging.hxx
@@ -17,12 +17,24 @@
 namespace zenoh {
 
 #ifdef ZENOHCXX_ZENOHC
-/// @brief Enable logging.
+/// @brief Initializes the zenoh runtime logger, using rust environment settings.
+/// E.g.: `RUST_LOG=info` will enable logging at info level. Similarly, you can set the variable to `error` or `debug`.
+/// Note that if the environment variable is not set, then logging will not be enabled.
+/// See https://docs.rs/env_logger/latest/env_logger/index.html for accepted filter format.
+/// @note zenoh-c only.
+inline void try_init_log_from_env() { ::zc_try_init_log_from_env(); }
+
+/// @brief Initializes the zenoh runtime logger, using rust environment settings or the provided fallback filter.
+/// E.g.: `RUST_LOG=info` will enable logging at info level. Similarly, you can set the variable to `error` or `debug`.
 ///
-/// User may set environment variable RUST_LOG to values *debug* | *info* | *warn* | *error* to show diagnostic output.
+/// Note that if the environment variable is not set, then fallback filter will be used instead.
+/// See https://docs.rs/env_logger/latest/env_logger/index.html for accepted filter format.
 ///
-/// @note zenoh-c only
-inline void init_logging() { ::zc_init_logging(); }
+/// @param fallback_filter: The fallback filter if the `RUST_LOG` environment variable is not set.
+/// @note zenoh-c only.
+inline void init_log_from_env_or(const std::string& fallback_filter) {
+    ::zc_init_log_from_env_or(fallback_filter.c_str());
+}
 #endif
 
 }  // namespace zenoh
diff --git a/tests/zenohc/config.cxx b/tests/zenohc/config.cxx
@@ -36,7 +36,7 @@ void test_config_to_string() {
 }
 
 int main(int argc, char** argv) {
-    init_logging();
+    init_log_from_env_or("error");
     test_config_insert();
     test_config_to_string();
     // TODO: add more tests

diff --git a/zenoh-c b/zenoh-c
diff --git a/zenoh-pico b/zenoh-pico