Skip to content
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

align logging with zenoh-c #215

Merged
merged 2 commits into from
Sep 13, 2024
Merged

align logging with zenoh-c #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c156151
align logging with zenoh-c
DenisBiryukov91 Sep 13, 2024
5908c96
add logging to all the examples
DenisBiryukov91 Sep 13, 2024
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
3 changes: 2 additions & 1 deletion docs/commons.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,5 @@ Sample
Logging
-------

.. doxygenfunction:: init_logging
.. doxygenfunction:: try_init_log_from_env
.. doxygenfunction:: init_log_from_env_or
3 changes: 3 additions & 0 deletions examples/simple/universal/z_simple.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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));

Expand Down
1 change: 1 addition & 0 deletions examples/simple/zenohc/zc_simple.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!");
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_delete.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_get.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_get_attachment.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_get_channel.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_get_channel_non_blocking.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_info.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_ping.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_pong.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_pub.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_pub_attachment.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_pub_delete.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_pub_thr.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_put.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_queryable.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_queryable_attachment.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_scout.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_sub.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_sub_attachment.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/universal/z_sub_thr.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/zenohc/z_get_liveliness.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/zenohc/z_get_shm.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/zenohc/z_liveliness.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/zenohc/z_ping_shm.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/zenohc/z_pub_shm.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/zenohc/z_pub_shm_thr.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/zenohc/z_queryable_shm.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/zenohc/z_sub_liveliness.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
3 changes: 3 additions & 0 deletions examples/zenohc/z_sub_shm.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
20 changes: 16 additions & 4 deletions include/zenoh/api/logging.hxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion tests/zenohc/config.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion zenoh-c
Open in desktop
Submodule zenoh-c updated 44 files
+1 −1 .github/workflows/ci.yml
+1 −1 .readthedocs.yaml
+0 −5 CMakeLists.txt
+0 −1 Cargo.toml
+0 −1 Cargo.toml.in
+0 −4 README.md
+3 −2 docs/api.rst
+2 −0 examples/z_delete.c
+2 −0 examples/z_get.c
+2 −0 examples/z_get_liveliness.c
+3 −0 examples/z_get_shm.c
+2 −0 examples/z_info.c
+2 −0 examples/z_liveliness.c
+2 −0 examples/z_non_blocking_get.c
+2 −0 examples/z_ping.c
+3 −0 examples/z_ping_shm.c
+2 −0 examples/z_pong.c
+2 −0 examples/z_pub.c
+2 −0 examples/z_pub_attachment.c
+2 −0 examples/z_pub_cache.c
+2 −0 examples/z_pub_shm.c
+2 −0 examples/z_pub_shm_thr.c
+2 −0 examples/z_pub_thr.c
+2 −0 examples/z_pull.c
+2 −0 examples/z_put.c
+2 −0 examples/z_query_sub.c
+2 −0 examples/z_queryable.c
+3 −0 examples/z_queryable_shm.c
+2 −0 examples/z_queryable_with_channels.c
+2 −0 examples/z_scout.c
+2 −0 examples/z_sub.c
+2 −0 examples/z_sub_attachment.c
+2 −0 examples/z_sub_liveliness.c
+2 −0 examples/z_sub_shm.c
+2 −0 examples/z_sub_thr.c
+21 −7 include/zenoh_commons.h
+30 −9 src/lib.rs
+2 −1 src/payload.rs
+1 −4 src/scouting.rs
+1 −7 src/session.rs
+1 −1 tests/z_api_alignment_test.c
+1 −1 tests/z_api_config_test.c
+1 −1 tests/z_api_double_drop_test.c
+1 −1 tests/z_api_drop_options.c
2 changes: 1 addition & 1 deletion zenoh-pico
Open in desktop
Submodule zenoh-pico updated 1 files
+1 −0 include/zenoh-pico/api/primitives.h
Loading