knowrob::Logger Class Reference

#include <Logger.h>

Public Types
enum	SinkType { File , Console , File , Console }
enum	SinkType { File , Console , File , Console }

Static Public Member Functions
static void	initialize ()
static void	loadConfiguration (boost::property_tree::ptree &config)
static void	setupFileSink (const std::string &basename="knowrob.log", bool rotate=true, uint32_t max_size=1048576, uint32_t max_files=4)
static void	setSinkLevel (SinkType sinkType, spdlog::level::level_enum log_level)
static void	setSinkPattern (SinkType sinkType, const std::string &pattern)
static std::string	formatGenericFailure (const std::string &name, const std::string &type)
static void	initialize ()
static void	loadConfiguration (boost::property_tree::ptree &config)
static void	setupFileSink (const std::string &basename="knowrob.log", bool rotate=true, uint32_t max_size=1048576, uint32_t max_files=4)
static void	setSinkLevel (SinkType sinkType, spdlog::level::level_enum log_level)
static void	setSinkPattern (SinkType sinkType, const std::string &pattern)
static std::string	formatGenericFailure (const std::string &name, const std::string &type)

Protected Member Functions
	Logger ()
void	updateLogger ()
	Logger ()
void	updateLogger ()

Static Protected Member Functions
static Logger &	get ()
static Logger &	get ()

Protected Attributes
std::unique_ptr< impl >	pimpl_

Detailed Description

Interface to initialize and configure the default logger of the system. The default logger is used within the logging macros KB_INFO, KB_ERROR, ...

Definition at line 75 of file Logger.h.

Member Enumeration Documentation

SinkType [1/2]

enum knowrob::Logger::SinkType

The type of a logging sink.

Enumerator
File
Console
File
Console

Definition at line 80 of file Logger.h.

{ File, Console };

SinkType [2/2]

enum knowrob::Logger::SinkType

The type of a logging sink.

Enumerator
File
Console
File
Console

Definition at line 80 of file Logger.h.

{ File, Console };

Constructor & Destructor Documentation

Logger() [1/2]

Logger::Logger ( )

protected

Definition at line 23 of file Logger.cpp.

        : pimpl_{std::make_unique<impl>()} {
    updateLogger();
}

Logger() [2/2]

knowrob::Logger::Logger ( )

protected

Member Function Documentation

formatGenericFailure() [1/2]

std::string Logger::formatGenericFailure ( const std::string &  name, const std::string &  type  )

static

Parameters

name	the name of a component.
type	the type of action that failed.

Returns

a formatted error message.

Definition at line 154 of file Logger.cpp.

                                                                                   {
    if (name.empty()) {
        return fmt::format(R"(Failed to execute action of type "{}")", type);
    } else {
        return fmt::format(R"(Component "{}" failed to execute action of type "{}")", name, type);
    }
}

formatGenericFailure() [2/2]

static std::string knowrob::Logger::formatGenericFailure ( const std::string &  name, const std::string &  type  )

static

Parameters

name	the name of a component.
type	the type of action that failed.

Returns

a formatted error message.

get() [1/2]

Logger & Logger::get ( )

staticprotected

Definition at line 40 of file Logger.cpp.

                    {
    static Logger singleton;
    return singleton;
}

get() [2/2]

static Logger& knowrob::Logger::get ( )

staticprotected

initialize() [1/2]

void Logger::initialize ( )

static

Initialize the logging subsystem, i.e., configure it with default parameters. The configuration may be changed at a later point, e.g. when reading a settings file.

Definition at line 45 of file Logger.cpp.

                        {
    setSinkLevel(Console, spdlog::level::info);
    setSinkPattern(Console, "[%$%H:%M:%S.%e] [%^%l%$] %v");
}

initialize() [2/2]

static void knowrob::Logger::initialize ( )

static

Initialize the logging subsystem, i.e., configure it with default parameters. The configuration may be changed at a later point, e.g. when reading a settings file.

loadConfiguration() [1/2]

void Logger::loadConfiguration ( boost::property_tree::ptree &  config )

static

Configure logging using a property tree.

Parameters

config

a property tree.

Definition at line 76 of file Logger.cpp.

                                                              {
    auto consoleConfig = config.get_child_optional("console-sink");
    if (consoleConfig) {
        auto level = consoleConfig.value().get_optional<std::string>("level");
        auto pattern = consoleConfig.value().get_optional<std::string>("pattern");
        if (level.has_value()) {
            setSinkLevel(Console, spdlog::level::from_str(level.value()));
        }
        if (pattern.has_value()) {
            setSinkPattern(Console, pattern.value());
        }
    }
 
    auto fileConfig = config.get_child_optional("file-sink");
    if (fileConfig) {
        auto &fileConfig0 = fileConfig.value();
        auto path = getLoggingPath(fileConfig0.get_optional<std::string>("path"));
        auto basename = fileConfig0.get<std::string>("basename", "knowrob.log");
 
        KB_INFO("[KnowRob] Writing logs to {}", path.native());
 
        setupFileSink((path / basename).native(),
                      fileConfig0.get<bool>("rotate", true),
                      fileConfig0.get<uint32_t>("max_size", 1048576),
                      fileConfig0.get<uint32_t>("max_files", 4));
 
        auto level = fileConfig0.get_optional<std::string>("level");
        auto pattern = fileConfig0.get_optional<std::string>("pattern");
        if (level.has_value()) {
            setSinkLevel(File, spdlog::level::from_str(level.value()));
        }
        if (pattern.has_value()) {
            setSinkPattern(File, pattern.value());
        }
    }
 
    auto flushInterval = config.get_optional<int64_t>("flush-interval");
    if (flushInterval.has_value()) {
        spdlog::flush_every(std::chrono::seconds(flushInterval.value()));
    }
}

loadConfiguration() [2/2]

static void knowrob::Logger::loadConfiguration ( boost::property_tree::ptree &  config )

static

Configure logging using a property tree.

Parameters

config

a property tree.

setSinkLevel() [1/2]

void Logger::setSinkLevel ( SinkType  sinkType, spdlog::level::level_enum  log_level  )

static

Parameters

sinkType	the type of the sink to configure.
log_level	the logging level for the console sink.

Definition at line 130 of file Logger.cpp.

                                                                            {
    switch (sinkType) {
        case Console:
            get().pimpl_->console_sink->set_level(log_level);
            break;
        case File:
            if (get().pimpl_->file_sink)
                get().pimpl_->file_sink->set_level(log_level);
            break;
    }
}

setSinkLevel() [2/2]

static void knowrob::Logger::setSinkLevel ( SinkType  sinkType, spdlog::level::level_enum  log_level  )

static

Parameters

sinkType	the type of the sink to configure.
log_level	the logging level for the console sink.

setSinkPattern() [1/2]

void Logger::setSinkPattern ( SinkType  sinkType, const std::string &  pattern  )

static

Parameters

sinkType	the type of the sink to configure.
pattern	the logging pattern for the console sink.

Definition at line 142 of file Logger.cpp.

                                                                       {
    switch (sinkType) {
        case Console:
            get().pimpl_->console_sink->set_pattern(pattern);
            break;
        case File:
            if (get().pimpl_->file_sink)
                get().pimpl_->file_sink->set_pattern(pattern);
            break;
    }
}

setSinkPattern() [2/2]

static void knowrob::Logger::setSinkPattern ( SinkType  sinkType, const std::string &  pattern  )

static

Parameters

sinkType	the type of the sink to configure.
pattern	the logging pattern for the console sink.

setupFileSink() [1/2]

void Logger::setupFileSink ( const std::string &  basename = "knowrob.log", bool  rotate = true, uint32_t  max_size = 1048576, uint32_t  max_files = 4  )

static

Create a new fie sink. Any existing file sink will be replaced by the new one.

Parameters

basename	the base name of log files
rotate	true if files should be rotated on opening
max_size	max size of log files before rotation
max_files	max number of stored files

Definition at line 118 of file Logger.cpp.

                                               {
    auto &self = get();
    self.pimpl_->file_sink = std::make_shared<spdlog::sinks::rotating_file_sink_mt>(
            basename, max_size, max_files, rotate);
    setSinkLevel(File, spdlog::level::trace);
    setSinkPattern(File, "[%c] [thread:%t] [%^%l%$] %v (%s:%#)");
    self.updateLogger();
}

setupFileSink() [2/2]

static void knowrob::Logger::setupFileSink ( const std::string &  basename = "knowrob.log", bool  rotate = true, uint32_t  max_size = 1048576, uint32_t  max_files = 4  )

static

Create a new fie sink. Any existing file sink will be replaced by the new one.

Parameters

basename	the base name of log files
rotate	true if files should be rotated on opening
max_size	max size of log files before rotation
max_files	max number of stored files

updateLogger() [1/2]

void Logger::updateLogger ( )

protected

Definition at line 28 of file Logger.cpp.

                          {
    if (pimpl_->file_sink)
        pimpl_->logger = std::make_shared<spdlog::logger>(
                "multi_sink", spdlog::sinks_init_list({pimpl_->console_sink, pimpl_->file_sink}));
    else
        pimpl_->logger = std::make_shared<spdlog::logger>(
                "multi_sink", spdlog::sinks_init_list({pimpl_->console_sink}));
    spdlog::set_default_logger(pimpl_->logger);
    spdlog::set_level(spdlog::level::trace);
    spdlog::flush_every(std::chrono::seconds(2));
}

updateLogger() [2/2]

void knowrob::Logger::updateLogger ( )

protected

Member Data Documentation

pimpl_

std::unique_ptr< impl > knowrob::Logger::pimpl_

protected

Definition at line 129 of file Logger.h.

---

The documentation for this class was generated from the following files:

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/Logger.h
• src/Logger.cpp