logging::Logger Class Reference

Thread-safe logger class for handling logging operations. More...

#include "logging.h"

Public Types
using	Callback = void(*)(Level level, const std::string &line, void *user_data)

Public Member Functions
void	setLevel (Level level) noexcept
	Sets the logging level.
Level	getLevel () const noexcept
	Gets the current logging level.
void	setCallback (Callback callback, void *user_data) noexcept
	Sets an optional callback that receives each formatted log line.
void	log (Level level, const std::string &message, const std::source_location &location=std::source_location::current()) noexcept
	Logs a message with a specific log level and source location.
template<typename... Args>
void	log (const Level level, const std::source_location &location, const std::string &formatStr, Args &&... args) noexcept
	Logs a formatted message with a specific log level and source location.
std::expected< void, std::string >	logToFile (const std::string &filePath) noexcept
	Sets the log file path to log messages to a file.

Detailed Description

Thread-safe logger class for handling logging operations.

Definition at line 52 of file logging.h.

Member Typedef Documentation

Callback

using logging::Logger::Callback = void (*)(Level level, const std::string& line, void* user_data)

Definition at line 55 of file logging.h.

Member Function Documentation

getLevel()

Level logging::Logger::getLevel ( ) const

noexcept

Gets the current logging level.

Returns

The current minimum logging level.

Definition at line 27 of file logging.cpp.

{ return _log_level.load(std::memory_order_relaxed); }

Referenced by log().

Here is the caller graph for this function:

log() [1/2]

template<typename... Args>

void logging::Logger::log ( const Level  level, const std::source_location &  location, const std::string &  formatStr, Args &&...  args  )

noexcept

Logs a formatted message with a specific log level and source location.

Template Parameters

Args	Variadic template for format arguments.

Parameters

level	The log level.
location	The source location of the log call.
formatStr	The format string.
args	The format arguments.

Definition at line 99 of file logging.h.

        {
            if (level != Level::OFF && level >= getLevel())
            {
                const std::string message = std::vformat(formatStr, std::make_format_args(args...));
                log(level, message, location);
            }
        }

References getLevel(), log(), and logging::OFF.

Here is the call graph for this function:

log() [2/2]

void logging::Logger::log ( Level  level, const std::string &  message, const std::source_location &  location = std::source_location::current()  )

noexcept

Logs a message with a specific log level and source location.

Parameters

level	The log level.
message	The message to log.
location	The source location of the log call.

Definition at line 45 of file logging.cpp.

    {
        if (level != Level::OFF && level >= getLevel())
        {
            Callback callback = nullptr;
            void* callback_user_data = nullptr;
            std::string line;
 
            {
                std::scoped_lock lock(_log_mutex);
 
                const std::string filename = std::filesystem::path(location.file_name()).filename().string();
                const std::string file_line = filename + ":" + std::to_string(location.line());
 
                std::ostringstream oss;
                oss << "[" << getCurrentTimestamp() << "] " << "[" << std::setw(7) << std::left << getLevelString(level)
                    << "] " << "[" << std::setw(30) << std::left << file_line << "] " << message;
                line = oss.str();
 
                std::cerr << line << '\n';
 
                if (_log_file && _log_file->is_open())
                {
                    *_log_file << line << '\n';
                    _log_file->flush();
                }
 
                callback = _callback;
                callback_user_data = _callback_user_data;
            }
 
            if (callback != nullptr)
            {
                callback(level, line, callback_user_data);
            }
        }
    }

References logging::getLevelString(), and logging::OFF.

Referenced by fers_log(), log(), and logging::log().

Here is the call graph for this function:

Here is the caller graph for this function:

logToFile()

std::expected< void, std::string > logging::Logger::logToFile ( const std::string &  filePath )

noexcept

Sets the log file path to log messages to a file.

Parameters

filePath

The path to the log file.

Returns

std::expected indicating success or error message on failure.

Definition at line 90 of file logging.cpp.

    {
        std::scoped_lock lock(_log_mutex);
 
        std::ofstream file(filePath, std::ios::out | std::ios::trunc);
        if (!file)
        {
            return std::unexpected("Unable to open log file: " + filePath);
        }
 
        _log_file = std::move(file);
        return {};
    }

Referenced by fers_configure_logging().

Here is the caller graph for this function:

setCallback()

void logging::Logger::setCallback ( Callback  callback, void *  user_data  )

noexcept

Sets an optional callback that receives each formatted log line.

Parameters

callback	Callback to invoke after a log line is accepted, or nullptr to disable.
user_data	Opaque caller data passed back to the callback.

Definition at line 83 of file logging.cpp.

    {
        std::scoped_lock lock(_log_mutex);
        _callback = callback;
        _callback_user_data = user_data;
    }

Referenced by fers_set_log_callback().

Here is the caller graph for this function:

setLevel()

void logging::Logger::setLevel ( Level  level )

noexcept

Sets the logging level.

Parameters

level

The logging level to set.

Definition at line 25 of file logging.cpp.

{ _log_level.store(level, std::memory_order_relaxed); }

Referenced by fers_configure_logging().

Here is the caller graph for this function:

---

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

• packages/libfers/src/core/logging.h
• packages/libfers/src/core/logging.cpp