Fix logging source location

[caguero]

🦟 Bug fix

Fixes #147

According to the spdlog notes about location flags, when using source location flags it's necessary to define this compiler flag:

#define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_TRACE

and then, use the SPDLOG_LOGGER_XXX() macros. This patch adds the #define and updates the example.

Without this patch:

(2024-09-26 19:53:49.435) [info] [:] info
(2024-09-26 19:53:49.435) [warning] [:] warn
(2024-09-26 19:53:49.435) [error] [:] error
(2024-09-26 19:53:49.435) [critical] [:] critical

With this patch:

(2024-09-26 19:52:52.543) [info] [main.cc:34] info
(2024-09-26 19:52:52.543) [warning] [main.cc:35] warn
(2024-09-26 19:52:52.543) [error] [main.cc:36] error
(2024-09-26 19:52:52.543) [critical] [main.cc:37] critical

Summary

Checklist

• Signed all commits for DCO
• Added tests
• Updated documentation (as needed)
• Updated migration guide (as needed)
• Consider updating Python bindings (if the library has them)
• codecheck passed (See contributing)
• All tests passed (See test coverage)
• While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

[azeey]

I'm surprised that the source location works for gz* macros (fix in #144), but not when using spdlog directly. Are we doing something different for our macros?

[caguero]

I'm surprised that the source location works for gz* macros (fix in #144), but not when using spdlog directly. Are we doing something different for our macros?

Yes, we are doing something different in the gz* macros. We're explicitly passing __FILE__ and __LINE__ in the macro. With this change that shouldn't be necessary.
https://github.com/gazebosim/gz-common/blob/gz-common6/include/gz/common/Console.hh#L67-L68

This version should be the equivalent to what we do in gz-common but I think it's more elegant what I'm proposing here. In any case both options are compatible.

[iche033]

tested and confirmed that the example now prints out source file name and line no.

[iche033]

windows caught a compile error:

C:\J\workspace\gz_utils-pr-win\ws\gz-utils\log\src\Logger_TEST.cc(146,35): error C2664: 'void gz::utils::log::v3::Logger::SetLogDestination(const std::string &)': cannot convert argument 1 from 'std::filesystem::path' to 'const std::string &' [C:\J\workspace\gz_utils-pr-win\ws\build\gz-utils3\log\src\UNIT_Logger_TEST.vcxproj]

windows CI caught compile error

[iche033]

windows caught a compile error:

C:\J\workspace\gz_utils-pr-win\ws\gz-utils\log\src\Logger_TEST.cc(146,35): error C2664: 'void gz::utils::log::v3::Logger::SetLogDestination(const std::string &)': cannot convert argument 1 from 'std::filesystem::path' to 'const std::string &' [C:\J\workspace\gz_utils-pr-win\ws\build\gz-utils3\log\src\UNIT_Logger_TEST.vcxproj]

testing fix: b94745f