Merge pull request #683 from eclipse-zenoh/dev/init_log_from_env_or

dev/init log from env or

.github/workflows/ci.yml

@@ -105,7 +105,7 @@ jobs:
           cd .. && rm -rf build_examples
 
       - name: Run rust tests
-        run: cargo test --verbose --release --features=logger-autoinit
+        run: cargo test --verbose --release
 
       - name: Upload artifact
         if: ${{ matrix.unstable == 'false' && matrix.shm == 'false' }}

.readthedocs.yaml

@@ -16,7 +16,7 @@ build:
   jobs:
     # Run cargo build to build git ignored files that are platform specific (e.g. include/zenoh_opaque.h)
     pre_build:
-      - cargo build --release --manifest-path=./Cargo.toml --features=logger-autoinit --features=unstable --features=shared-memory
+      - cargo build --release --manifest-path=./Cargo.toml --features=unstable --features=shared-memory
 
 
 # Build documentation in the docs/ directory with Sphinx

CMakeLists.txt

@@ -27,7 +27,6 @@ enable_testing()
 # Configuration options
 #
 declare_cache_var_true_if_vscode(ZENOHC_BUILD_IN_SOURCE_TREE "Do build inside source tree")
-declare_cache_var(ZENOHC_BUILD_WITH_LOGGER_AUTOINIT TRUE BOOL "Enable logger-autoinit zenoh-c feature")
 declare_cache_var(ZENOHC_BUILD_WITH_SHARED_MEMORY FALSE BOOL "Enable shared-memory zenoh-c feature")
 declare_cache_var(ZENOHC_BUILD_WITH_UNSTABLE_API FALSE BOOL "Enable unstable API feature")
 declare_cache_var(ZENOHC_BUILD_TESTS_WITH_CXX FALSE BOOL "Use C++ compiler for building tests to check API's C++ compatibility")
@@ -200,10 +199,6 @@ set_genexpr_condition(cargo_flags DEBUG $<CONFIG:Debug>
 	"--release;--manifest-path=${cargo_toml_dir_release}/Cargo.toml")
 set(cargo_flags ${cargo_flags} ${ZENOHC_CARGO_FLAGS})
 
-if(ZENOHC_BUILD_WITH_LOGGER_AUTOINIT)
-	set(cargo_flags ${cargo_flags} --features=logger-autoinit)
-endif()
-
 if(ZENOHC_BUILD_WITH_SHARED_MEMORY)
 	set(cargo_flags ${cargo_flags} --features=shared-memory)
 endif()

Cargo.toml

@@ -31,7 +31,6 @@ build = "build.rs"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
-logger-autoinit = []
 shared-memory = ["zenoh/shared-memory", "dep:zenoh-ext", "zenoh-ext/shared-memory"]
 unstable = ["zenoh/unstable", "zenoh-ext/unstable", "dep:zenoh-ext"]
 default = ["zenoh/default"]

Cargo.toml.in

@@ -31,7 +31,6 @@ build = "@[email protected]"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
-logger-autoinit = []
 shared-memory = ["zenoh/shared-memory", "dep:zenoh-ext", "zenoh-ext/shared-memory"]
 unstable = ["zenoh/unstable", "zenoh-ext/unstable", "dep:zenoh-ext"]
 default = ["zenoh/default"]

README.md

@@ -211,10 +211,6 @@ Finally, we strongly advise that you refrain from using structure field that sta
 - We try to maintain a common API between `zenoh-c` and [`zenoh-pico`](https://github.com/eclipse-zenoh/zenoh-pico), such that porting code from one to the other is, ideally, trivial. However, some types must have distinct representations in either library, meaning that using these representations explicitly will get you in trouble when porting.
 - We reserve the right to change the memory layout of any type which has `_`-prefixed fields, so trying to use them might cause your code to break on updates.
 
-## Logging
-
-By default, zenoh-c enables Zenoh's logging library upon using the `z_open` or `z_scout` functions. This behavior can be disabled by adding `-DDISABLE_LOGGER_AUTOINIT:bool=true` to the `cmake` configuration command. The logger may then be manually re-enabled with the `zc_init_logging` function.
-
 ## Cross-Compilation
 
 The following alternative options have been introduced to facilitate cross-compilation.

docs/api.rst

@@ -827,7 +827,8 @@ Types
 Functions
 ---------
 
-.. doxygenfunction:: zc_init_logging
+.. doxygenfunction:: zc_try_init_log_from_env
+.. doxygenfunction:: zc_init_log_from_env_or
 .. doxygenfunction:: zc_init_logging_with_callback
 
 

examples/z_delete.c

@@ -25,6 +25,8 @@ struct args_t {
 struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_get.c

@@ -27,6 +27,8 @@ struct args_t {
 struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_get_liveliness.c

@@ -25,6 +25,8 @@ struct args_t {
 struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_get_shm.c

@@ -32,11 +32,14 @@ int main(int argc, char** argv) {
     }
     size_t value_len = value ? strlen(value) : 0;
 
+    zc_init_log_from_env_or("error");
+
     z_view_keyexpr_t keyexpr;
     if (z_view_keyexpr_from_str(&keyexpr, expr) < 0) {
         printf("%s is not a valid key expression", expr);
         exit(-1);
     }
+
     z_owned_config_t config;
     z_config_default(&config);
 

examples/z_info.c

@@ -26,6 +26,8 @@ void print_zid(const z_id_t* id, void* ctx) {
 void parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     parse_args(argc, argv, &config);
 

examples/z_liveliness.c

@@ -25,6 +25,8 @@ struct args_t {
 struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_non_blocking_get.c

@@ -25,6 +25,8 @@ struct args_t {
 struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_ping.c

@@ -32,6 +32,8 @@ struct args_t {
 struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_ping_shm.c

@@ -47,6 +47,9 @@ int main(int argc, char** argv) {
     }
     z_mutex_init(&mutex);
     z_condvar_init(&cond);
+
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     if (args.config_path) {
         zc_config_from_file(&config, args.config_path);

examples/z_pong.c

@@ -22,6 +22,8 @@ void drop(void* context) {
 }
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     parse_args(argc, argv, &config);
 

examples/z_pub.c

@@ -38,6 +38,8 @@ void matching_status_handler(const zc_matching_status_t* matching_status, void*
 #endif
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_pub_attachment.c

@@ -50,6 +50,8 @@ struct args_t {
 struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_pub_cache.c

@@ -29,6 +29,8 @@ struct args_t {
 struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_pub_shm.c

@@ -39,6 +39,8 @@ void matching_status_handler(const zc_matching_status_t* matching_status, void*
 #endif
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_pub_shm_thr.c

@@ -25,6 +25,8 @@ int main(int argc, char **argv) {
     char *keyexpr = "test/thr";
     size_t len = atoi(argv[1]);
 
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     z_config_default(&config);
 

examples/z_pub_thr.c

@@ -25,6 +25,8 @@ struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 int main(int argc, char** argv) {
     char* keyexpr = "test/thr";
 
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
     uint8_t* value = (uint8_t*)z_malloc(args.size);

examples/z_pull.c

@@ -37,6 +37,8 @@ void handle_sample(const z_loaned_sample_t* sample) {
 }
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_put.c

@@ -27,6 +27,8 @@ struct args_t {
 struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_query_sub.c

@@ -38,6 +38,8 @@ void data_handler(z_loaned_sample_t* sample, void* arg) {
 }
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_queryable.c

@@ -63,6 +63,8 @@ void query_handler(z_loaned_query_t *query, void *context) {
 }
 
 int main(int argc, char **argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
     value = args.value;

examples/z_queryable_shm.c

@@ -79,6 +79,9 @@ int main(int argc, char **argv) {
     if (argc > 1) {
         keyexpr = argv[1];
     }
+
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     z_config_default(&config);
     if (argc > 2) {

examples/z_queryable_with_channels.c

@@ -29,6 +29,8 @@ struct args_t parse_args(int argc, char** argv, z_owned_config_t* config);
 z_view_keyexpr_t ke;
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
 

examples/z_scout.c

@@ -88,6 +88,8 @@ void drop(void *context) {
 }
 
 int main(int argc, char **argv) {
+    zc_init_log_from_env_or("error");
+
     int *context = z_malloc(sizeof(int));
     *context = 0;
     z_owned_config_t config;

examples/z_sub.c

@@ -39,6 +39,8 @@ void data_handler(z_loaned_sample_t *sample, void *arg) {
 }
 
 int main(int argc, char **argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
     z_view_keyexpr_t ke;

examples/z_sub_attachment.c

@@ -63,6 +63,8 @@ void data_handler(z_loaned_sample_t* sample, void* arg) {
 }
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
     z_view_keyexpr_t ke;

examples/z_sub_liveliness.c

@@ -39,6 +39,8 @@ void data_handler(z_loaned_sample_t* sample, void* arg) {
 }
 
 int main(int argc, char** argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     struct args_t args = parse_args(argc, argv, &config);
     z_view_keyexpr_t ke;

examples/z_sub_shm.c

@@ -58,6 +58,8 @@ int main(int argc, char **argv) {
         keyexpr = argv[1];
     }
 
+    zc_init_log_from_env_or("error");
+
     z_view_keyexpr_t ke;
     z_view_keyexpr_from_str(&ke, keyexpr);
 

examples/z_sub_thr.c

@@ -63,6 +63,8 @@ void drop_stats(void *context) {
 }
 
 int main(int argc, char **argv) {
+    zc_init_log_from_env_or("error");
+
     z_owned_config_t config;
     parse_args(argc, argv, &config);