rename to log manager and global logger

Author: lia-viam

src/viam/sdk/common/instance.cpp

@@ -27,7 +27,7 @@ Instance::Instance() {
 
     impl_ = std::make_unique<Instance::Impl>();
     impl_->registry.initialize();
-    impl_->logger.init_logging();
+    impl_->log_mgr.init_logging();
 }
 
 Instance::~Instance() {

src/viam/sdk/common/instance.hpp

@@ -28,7 +28,7 @@ class Instance {
 
    private:
     friend class Registry;
-    friend class Logger;
+    friend class LogManager;
 
     struct Impl;
     std::unique_ptr<Impl> impl_;

src/viam/sdk/common/private/instance.hpp

@@ -9,7 +9,7 @@ namespace sdk {
 
 struct Instance::Impl {
     Registry registry;
-    Logger logger;
+    LogManager log_mgr;
 };
 
 }  // namespace sdk

src/viam/sdk/log/logger.cpp

@@ -67,7 +67,7 @@ const char* global_resource_name() {
     return "Viam C++ SDK";
 }
 
-bool Logger::Filter::operator()(const boost::log::attribute_value_set& attrs) const {
+bool LogManager::Filter::operator()(const boost::log::attribute_value_set& attrs) const {
     auto sev = attrs[attr_sev_type{}];
     if (!sev) {
         return false;
@@ -84,31 +84,31 @@ bool Logger::Filter::operator()(const boost::log::attribute_value_set& attrs) co
     return *sev >= parent->global_level_;
 }
 
-Logger& Logger::get() {
-    static Logger& result = Instance::current(Instance::Creation::open_existing).impl_->logger;
+LogManager& LogManager::get() {
+    static LogManager& result = Instance::current(Instance::Creation::open_existing).impl_->log_mgr;
 
     return result;
 }
 
-LogSource& Logger::logger() {
+LogSource& LogManager::global_logger() {
     return sdk_logger_;
 }
 
-void Logger::set_global_log_level(log_level lvl) {
+void LogManager::set_global_log_level(log_level lvl) {
     global_level_ = lvl;
 }
 
-void Logger::set_global_log_level(int argc, char** argv) {
+void LogManager::set_global_log_level(int argc, char** argv) {
     if (argc >= 3 && strcmp(argv[2], "--log-level=debug") == 0) {
         set_global_log_level(log_level::debug);
     }
 }
 
-void Logger::set_resource_log_level(const std::string& resource, log_level lvl) {
+void LogManager::set_resource_log_level(const std::string& resource, log_level lvl) {
     resource_levels_[resource] = lvl;
 }
 
-void Logger::init_logging() {
+void LogManager::init_logging() {
     sdk_logger_.channel(global_resource_name());
     boost::log::core::get()->add_global_attribute("TimeStamp",
                                                   boost::log::attributes::local_clock());
@@ -134,7 +134,7 @@ void Logger::init_logging() {
     VIAM_LOG(debug) << "Initialized console logging";
 }
 
-void Logger::disable_console_logging() {
+void LogManager::disable_console_logging() {
     VIAM_LOG(debug) << "Disabling console logging";
     boost::log::core::get()->remove_sink(console_sink_);
 }

src/viam/sdk/log/logger.hpp

@@ -50,24 +50,24 @@ using LogSource = boost::log::sources::severity_channel_logger_mt<log_level>;
 /// @ingroup Log
 const char* global_resource_name();
 
-/// @class Logger logger.hpp "log/logger.hpp"
+/// @class LogManager logger.hpp "log/logger.hpp"
 /// @brief Manages the logging infrastructure in the SDDK.
 /// @ingroup Log
 ///
 /// Handles initialization and bookkeeping for logging infrastructure in the C++ SDK. This includes
 /// console logging, if active, and both global and resource-level log filtering.
-class Logger {
+class LogManager {
    public:
     struct Filter {
-        const Logger* parent;
+        const LogManager* parent;
 
         bool operator()(const boost::log::attribute_value_set&) const;
     };
 
     /// @brief Returns the unique logger instance.
     ///
     /// This is the only way to access the logger.
-    static Logger& get();
+    static LogManager& get();
 
     /// @brief Set the global logger severity.
     void set_global_log_level(log_level);
@@ -82,28 +82,29 @@ class Logger {
 
     /// @brief Set the logger severity for a resource.
     ///
-    /// Logger can maintain separate severity levels for individual resources. For example, you may
-    /// want to only report "error" messages for global logs and logs for one component of a modular
-    /// resource, but enable verbose logging for a new component that is still being debugged.
+    /// LogManager can maintain separate severity levels for individual resources. For example, you
+    /// may want to only report "error" messages for global logs and logs for one component of a
+    /// modular resource, but enable verbose logging for a new component that is still being
+    /// debugged.
     /// @see @ref Resource, which has a set_log_level method which automatically provides its own
     /// resource name.
     void set_resource_log_level(const std::string& resource, log_level);
 
     /// @brief Return the SDK global log source.
     ///
     /// Users should prefer to log messages using the logging macros below.
-    LogSource& logger();
+    LogSource& global_logger();
 
    private:
     friend class RobotClient;
     friend class Instance;
-    Logger() = default;
+    LogManager() = default;
 
-    Logger(const Logger&) = delete;
-    Logger(Logger&&) = delete;
+    LogManager(const LogManager&) = delete;
+    LogManager(LogManager&&) = delete;
 
-    Logger& operator=(const Logger&) = delete;
-    Logger& operator=(Logger&&) = delete;
+    LogManager& operator=(const LogManager&) = delete;
+    LogManager& operator=(LogManager&&) = delete;
 
     void init_logging();
     void disable_console_logging();
@@ -143,7 +144,7 @@ BOOST_LOG_ATTRIBUTE_KEYWORD_TYPE(attr_time,
 /// @ingroup Log
 ///
 /// Use this macro to generate log messages pertaining to the SDK at large.
-#define VIAM_LOG(level) VIAM_LOG_IMPL(::viam::sdk::Logger::get().logger(), level)
+#define VIAM_LOG(level) VIAM_LOG_IMPL(::viam::sdk::LogManager::get().global_logger(), level)
 
 /// @brief Log macro for resource-level logs.
 /// @ingroup Log

src/viam/sdk/module/service.cpp

@@ -237,7 +237,7 @@ ModuleService::ModuleService(int argc,
           }
           return argv[1];
       }()) {
-    Logger::get().set_global_log_level(argc, argv);
+    LogManager::get().set_global_log_level(argc, argv);
 
     for (auto&& mr : registrations) {
         Registry::get().register_model(mr);

src/viam/sdk/resource/resource.cpp

@@ -30,7 +30,7 @@ Name Resource::get_resource_name() const {
 }
 
 void Resource::set_log_level(log_level ll) const {
-    Logger::get().set_resource_log_level(name_, ll);
+    LogManager::get().set_resource_log_level(name_, ll);
 }
 
 }  // namespace sdk

src/viam/sdk/robot/client.cpp

@@ -101,9 +101,9 @@ void RobotClient::connect_logging() {
     auto& sink = impl_->log_sink;
     if (!sink) {
         sink = sdk::impl::LogBackend::create(this);
-        sink->set_filter(Logger::Filter{&Logger::get()});
+        sink->set_filter(LogManager::Filter{&LogManager::get()});
 
-        Logger::get().disable_console_logging();
+        LogManager::get().disable_console_logging();
         boost::log::core::get()->add_sink(sink);
     }
 }

src/viam/sdk/tests/test_log.cpp

@@ -36,7 +36,7 @@ BOOST_AUTO_TEST_CASE(test_global_filter) {
     VIAM_LOG(error) << "error1";
     VIAM_LOG(trace) << "trace1";  // not logged
 
-    auto& logger = sdk::Logger::get();
+    auto& logger = sdk::LogManager::get();
 
     using ll = sdk::log_level;