Logging macros, types, and functions for the irsol library. More...

Files
file	logging.hpp
	Logging utilities and configuration for the irsol library.

Classes
struct	irsol::internal::LoggerInfo
	Metadata for a named logger instance. More...

class	irsol::internal::NamedLoggerRegistry
	Manages a registry of named loggers. More...

Macros
#define	IRSOL_LOG_TRACE(...) SPDLOG_TRACE(__VA_ARGS__)
	Logs a trace-level message using the default logger.

#define	IRSOL_LOG_DEBUG(...) SPDLOG_DEBUG(__VA_ARGS__)
	Logs a debug-level message using the default logger.

#define	IRSOL_LOG_INFO(...) SPDLOG_INFO(__VA_ARGS__)
	Logs an info-level message using the default logger.

#define	IRSOL_LOG_WARN(...) SPDLOG_WARN(__VA_ARGS__)
	Logs a warning-level message using the default logger.

#define	IRSOL_LOG_ERROR(...) SPDLOG_ERROR(__VA_ARGS__)
	Logs an error-level message using the default logger.

#define	IRSOL_LOG_FATAL(...) SPDLOG_CRITICAL(__VA_ARGS__)
	Logs a fatal (critical) message using the default logger.

#define	IRSOL_NAMED_LOG_TRACE(name, ...) irsol::internal::NamedLoggerRegistry::getLogger(name)->trace(__VA_ARGS__)
	Logs a trace-level message using a named logger.

#define	IRSOL_NAMED_LOG_DEBUG(name, ...) irsol::internal::NamedLoggerRegistry::getLogger(name)->debug(__VA_ARGS__)
	Logs a debug-level message using a named logger.

#define	IRSOL_NAMED_LOG_INFO(name, ...) irsol::internal::NamedLoggerRegistry::getLogger(name)->info(__VA_ARGS__)
	Logs an info-level message using a named logger.

#define	IRSOL_NAMED_LOG_WARN(name, ...) irsol::internal::NamedLoggerRegistry::getLogger(name)->warn(__VA_ARGS__)
	Logs a warning-level message using a named logger.

#define	IRSOL_NAMED_LOG_ERROR(name, ...) irsol::internal::NamedLoggerRegistry::getLogger(name)->error(__VA_ARGS__)
	Logs an error-level message using a named logger.

#define	IRSOL_NAMED_LOG_FATAL(name, ...) irsol::internal::NamedLoggerRegistry::getLogger(name)->critical(__VA_ARGS__)
	Logs a fatal (critical) message using a named logger.

Enumerations
enum class	irsol::LoggingFormat { irsol::LoggingFormat::CONSOLE , irsol::LoggingFormat::FILE , irsol::LoggingFormat::UNIT_TESTS }
	Enum representing supported logging output formats. More...

Functions
void	irsol::setLoggingFormat (LoggingFormat format=LoggingFormat::FILE, std::optional< std::shared_ptr< spdlog::logger > > logger=std::nullopt)
	Sets the global logging format.

void	irsol::setSinkLoggingFormat (LoggingFormat format, std::shared_ptr< spdlog::sinks::sink > sink)
	Sets the logging format for a specific sink.

void	irsol::setLoggerName (const char *name)
	Sets the name of the default logger.

void	irsol::initLogging (const char *fileSinkFilename="logs/irsol.log", std::optional< spdlog::level::level_enum > minLogLevel=std::nullopt)
	Initializes the `irsol` logging system.

Variables
const std::unordered_map< std::string, spdlog::level::level_enum >	irsol::levelNameToLevelMap
	Runtime map from string names to spdlog log levels.

Detailed Description

Logging macros, types, and functions for the irsol library.

This group contains macros and helper utilities to log messages with different severity levels, configure logger output formats, and handle named loggers.

Macro Definition Documentation

◆ IRSOL_LOG_DEBUG

#define IRSOL_LOG_DEBUG ( ... ) SPDLOG_DEBUG(__VA_ARGS__)

Logs a debug-level message using the default logger.

Definition at line 91 of file logging.hpp.

◆ IRSOL_LOG_ERROR

#define IRSOL_LOG_ERROR ( ... ) SPDLOG_ERROR(__VA_ARGS__)

Logs an error-level message using the default logger.

Definition at line 94 of file logging.hpp.

◆ IRSOL_LOG_FATAL

#define IRSOL_LOG_FATAL ( ... ) SPDLOG_CRITICAL(__VA_ARGS__)

Logs a fatal (critical) message using the default logger.

Definition at line 95 of file logging.hpp.

◆ IRSOL_LOG_INFO

#define IRSOL_LOG_INFO ( ... ) SPDLOG_INFO(__VA_ARGS__)

Logs an info-level message using the default logger.

Definition at line 92 of file logging.hpp.

◆ IRSOL_LOG_TRACE

#define IRSOL_LOG_TRACE ( ... ) SPDLOG_TRACE(__VA_ARGS__)

Logs a trace-level message using the default logger.

Definition at line 90 of file logging.hpp.

◆ IRSOL_LOG_WARN

#define IRSOL_LOG_WARN ( ... ) SPDLOG_WARN(__VA_ARGS__)

Logs a warning-level message using the default logger.

Definition at line 93 of file logging.hpp.

◆ IRSOL_NAMED_LOG_DEBUG

#define IRSOL_NAMED_LOG_DEBUG	(	name,
		...
	)	irsol::internal::NamedLoggerRegistry::getLogger(name)->debug(__VA_ARGS__)

Logs a debug-level message using a named logger.

Definition at line 174 of file logging.hpp.

                {
 
enum class LoggingFormat
{
  CONSOLE,    
  FILE,       
  UNIT_TESTS  
};
 
void setLoggingFormat(
  LoggingFormat                                  format = LoggingFormat::FILE,
  std::optional<std::shared_ptr<spdlog::logger>> logger = std::nullopt);
 
void setSinkLoggingFormat(LoggingFormat format, std::shared_ptr<spdlog::sinks::sink> sink);
 
void setLoggerName(const char* name);
 
void initLogging(
  const char*                              fileSinkFilename = "logs/irsol.log",
  std::optional<spdlog::level::level_enum> minLogLevel      = std::nullopt);
 
inline const std::unordered_map<std::string, spdlog::level::level_enum> levelNameToLevelMap = {
#ifdef DEBUG
  {"trace", spdlog::level::trace},
  {"debug", spdlog::level::debug},
#endif
  {"info", spdlog::level::info},
  {"warn", spdlog::level::warn},
  {"error", spdlog::level::err}};
}  // namespace irsol

◆ IRSOL_NAMED_LOG_ERROR

#define IRSOL_NAMED_LOG_ERROR	(	name,
		...
	)	irsol::internal::NamedLoggerRegistry::getLogger(name)->error(__VA_ARGS__)

Logs an error-level message using a named logger.

Definition at line 180 of file logging.hpp.

◆ IRSOL_NAMED_LOG_FATAL

#define IRSOL_NAMED_LOG_FATAL	(	name,
		...
	)	irsol::internal::NamedLoggerRegistry::getLogger(name)->critical(__VA_ARGS__)

Logs a fatal (critical) message using a named logger.

Definition at line 182 of file logging.hpp.

◆ IRSOL_NAMED_LOG_INFO

#define IRSOL_NAMED_LOG_INFO	(	name,
		...
	)	irsol::internal::NamedLoggerRegistry::getLogger(name)->info(__VA_ARGS__)

Logs an info-level message using a named logger.

Definition at line 176 of file logging.hpp.

◆ IRSOL_NAMED_LOG_TRACE

#define IRSOL_NAMED_LOG_TRACE	(	name,
		...
	)	irsol::internal::NamedLoggerRegistry::getLogger(name)->trace(__VA_ARGS__)

Logs a trace-level message using a named logger.

Definition at line 172 of file logging.hpp.

◆ IRSOL_NAMED_LOG_WARN

#define IRSOL_NAMED_LOG_WARN	(	name,
		...
	)	irsol::internal::NamedLoggerRegistry::getLogger(name)->warn(__VA_ARGS__)

Logs a warning-level message using a named logger.

Definition at line 178 of file logging.hpp.

Enumeration Type Documentation

◆ LoggingFormat

enum class irsol::LoggingFormat

strongprivate

Enum representing supported logging output formats.

Enumerator
CONSOLE	Human-readable format for terminal output.
FILE	Persistent file logging format.
UNIT_TESTS	Format suitable for unit test frameworks.

Definition at line 191 of file logging.hpp.

{
  CONSOLE,    
  FILE,       
  UNIT_TESTS  
};

Function Documentation

◆ initLogging()

void irsol::initLogging	(	const char *	fileSinkFilename = `"logs/irsol.log"`,
		std::optional< spdlog::level::level_enum >	minLogLevel = `std::nullopt`
	)

private

Initializes the irsol logging system.

Creates and configures the global logger instance. This should typically be called once at application startup.

Parameters

fileSinkFilename	Path to the log file where logs are written to.
minLogLevel	Optional minimum log level to use at runtime.

Definition at line 108 of file logging.cpp.

{
#ifdef DEBUG
  // Set the logging level to debug if in debug mode
  const auto defaultConsoleLevel  = spdlog::level::trace;
  const auto defaultFileSinkLevel = spdlog::level::trace;
#else
  // Set the logging level to info if not in debug mode
  const auto defaultConsoleLevel  = spdlog::level::info;
  const auto defaultFileSinkLevel = spdlog::level::info;
#endif
 
  auto consoleSink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
  setSinkLoggingFormat(LoggingFormat::CONSOLE, consoleSink);
 
  const auto maxFileSize = 1024 * 1024 * 5;  // 5 MB
  const auto maxFiles    = 24;               // Keep 24 rotated files
  auto       fileSink    = std::make_shared<spdlog::sinks::rotating_file_sink_mt>(
    logFilePath, maxFileSize, maxFiles, false);
  setSinkLoggingFormat(LoggingFormat::FILE, fileSink);
 
  // Set the loggers as default loggers
  auto logger =
    std::make_shared<spdlog::logger>("irsol", spdlog::sinks_init_list{consoleSink, fileSink});
  spdlog::set_default_logger(logger);
 
#ifdef DEBUG
  // Force flush on trace level and above
  spdlog::flush_on(spdlog::level::trace);
#else
  // Force flush on error level and above
  spdlog::flush_on(spdlog::level::err);
#endif
 
  // Force flush every N seconds
  spdlog::flush_every(std::chrono::seconds(2));
 
  // Configure the levels for logging on the different sinks
  auto consoleLevel  = defaultConsoleLevel;
  auto fileSinkLevel = defaultFileSinkLevel;
  if(minLogLevel.has_value()) {
    // Override the console and file levels if needed
    consoleLevel  = std::max({defaultConsoleLevel, *minLogLevel});
    fileSinkLevel = std::max({defaultFileSinkLevel, *minLogLevel});
  }
  auto globalLevel = std::min({consoleLevel, fileSinkLevel});
 
  consoleSink->set_level(consoleLevel);
  fileSink->set_level(fileSinkLevel);
  logger->set_level(globalLevel);
 
#ifdef DEBUG
  spdlog::info("Logging initialized with sync levels");
  spdlog::info("Console {}", spdlog::level::to_string_view(consoleLevel));
  spdlog::info("File: {}", spdlog::level::to_string_view(fileSinkLevel));
  if(minLogLevel.has_value()) {
    spdlog::info("Global: {} (overridden)", spdlog::level::to_string_view(minLogLevel.value()));
  } else {
    spdlog::info("Global: {}", spdlog::level::to_string_view(globalLevel));
  }
#endif
}

◆ setLoggerName()

void irsol::setLoggerName ( const char * name )

private

Sets the name of the default logger.

Use this to label logs with a custom identifier. Useful for distinguishing between multiple libraries or subsystems.

Parameters

name	The desired logger name.

Definition at line 77 of file logging.cpp.

{
  auto logger = spdlog::default_logger()->clone(name);
  spdlog::set_default_logger(logger);
}

◆ setLoggingFormat()

void irsol::setLoggingFormat	(	LoggingFormat	format = `LoggingFormat::FILE`,
		std::optional< std::shared_ptr< spdlog::logger > >	logger = `std::nullopt`
	)

private

Sets the global logging format.

This function configures the default output format (e.g., console, file).

Parameters

format	The desired output format.
logger	Optional logger instance to configure, if not provided the format is set to default logger.

Definition at line 84 of file logging.cpp.

{
  auto thisLogger = logger.value_or(spdlog::default_logger());
  for(auto& sink : thisLogger->sinks()) {
    setSinkLoggingFormat(format, sink);
  }
}

◆ setSinkLoggingFormat()

void irsol::setSinkLoggingFormat	(	LoggingFormat	format,
		std::shared_ptr< spdlog::sinks::sink >	sink
	)

private

Sets the logging format for a specific sink.

Applies the appropriate formatter string to the given sink (e.g., console, file).

Parameters

format	The desired output format.
sink	The sink to configure.

Definition at line 92 of file logging.cpp.

{
  switch(format) {
    case LoggingFormat::FILE:
      sink->set_pattern("[%Y-%m-%d %H:%M:%S.%e][%^%l%$][%n][pid %P][tid %t][%s:%!():%#] %v");
      break;
    case LoggingFormat::CONSOLE:
      sink->set_pattern("[%H:%M:%S.%e][%^%l%$][%n][%s:%!():%#] %v");
      break;
    case LoggingFormat::UNIT_TESTS:
      sink->set_pattern("[%^%l%$][%s:%!():%#] %v");
      break;
  }
}

Variable Documentation

◆ levelNameToLevelMap

const std::unordered_map<std::string, spdlog::level::level_enum> irsol::levelNameToLevelMap

inlineprivate

Initial value:

= {
 
  {"info", spdlog::level::info},
  {"warn", spdlog::level::warn},
  {"error", spdlog::level::err}}

Runtime map from string names to spdlog log levels.

Allows dynamic parsing of log levels from configuration or user input.

Definition at line 254 of file logging.hpp.

                                                                                      {
#ifdef DEBUG
  {"trace", spdlog::level::trace},
  {"debug", spdlog::level::debug},
#endif
  {"info", spdlog::level::info},
  {"warn", spdlog::level::warn},
  {"error", spdlog::level::err}};

Files

Classes

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ IRSOL_LOG_DEBUG

◆ IRSOL_LOG_ERROR

◆ IRSOL_LOG_FATAL

◆ IRSOL_LOG_INFO

◆ IRSOL_LOG_TRACE

◆ IRSOL_LOG_WARN

◆ IRSOL_NAMED_LOG_DEBUG

◆ IRSOL_NAMED_LOG_ERROR

◆ IRSOL_NAMED_LOG_FATAL

◆ IRSOL_NAMED_LOG_INFO

◆ IRSOL_NAMED_LOG_TRACE

◆ IRSOL_NAMED_LOG_WARN

Enumeration Type Documentation

◆ LoggingFormat

Function Documentation

◆ initLogging()

◆ setLoggerName()

◆ setLoggingFormat()

◆ setSinkLoggingFormat()

Variable Documentation

◆ levelNameToLevelMap