The LogConfig class. More...

#include <LogConfig.h>

Public Types
enum	ELogLevel { c_Debug , c_Info , c_Result , c_Warning , c_Error , c_Fatal , c_Default }
	Definition of the supported log levels. More...

enum	ELogInfo { c_Level = 0x01 , c_Message = 0x02 , c_Module = 0x04 , c_Package = 0x08 , c_Function = 0x10 , c_File = 0x20 , c_Line = 0x40 , c_Timestamp = 0x80 , c_NoVariables = 0x100 }
	Definition of the supported log message information. More...

enum	ELogRealm { c_None , c_Online , c_Production }
	Definition of the supported execution realms. More...

Public Member Functions
	LogConfig (ELogLevel logLevel=c_Default, int debugLevel=c_DefaultDebugLevel)
	The LogConfig constructor.

void	setLogLevel (ELogLevel logLevel)
	Configure the log level.

ELogLevel	getLogLevel () const
	Returns the configured log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

int	getDebugLevel () const
	Returns the configured debug messaging level.

void	setAbortLevel (ELogLevel abortLevel)
	Configure the abort level.

ELogLevel	getAbortLevel () const
	Returns the configured abort level.

void	setLogInfo (ELogLevel logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.

unsigned int	getLogInfo (ELogLevel logLevel) const
	Returns the configured log information for the given level.

Static Public Member Functions
static const char *	logLevelToString (ELogLevel logLevelType)
	Converts a log level type to a string.

static const char *	logRealmToString (ELogRealm realm)
	Converts a log realm type to a string.

Static Public Attributes
static const int	c_DefaultDebugLevel = 10
	Default debug level.

Private Attributes
ELogLevel	m_logLevel
	The log messaging level.

int	m_debugLevel
	The debug messaging level.

ELogLevel	m_abortLevel
	The log level at which the execution should be stopped.

unsigned int	m_logInfo [c_Default]
	The kind of printed information per log level.

Detailed Description

The LogConfig class.

This class provides configuration settings for the logging system.

Definition at line 22 of file LogConfig.h.

Member Enumeration Documentation

◆ ELogInfo

enum ELogInfo

Definition of the supported log message information.

Enumerator
c_Level	Log level of the message.
c_Message	Log message text.
c_Module	Module in which the message was emitted.
c_Package	Package in which the message was emitted.
c_Function	Function in which the message was emitted.
c_File	Source file in which the message was emitted.
c_Line	Line in source file in which the message was emitted.
c_Timestamp	Time at which the message was emitted.
c_NoVariables	If set don't output any variables that are part of the message.

Definition at line 36 of file LogConfig.h.

                  { c_Level = 0x01,        
                    c_Message = 0x02,      
                    c_Module = 0x04,       
                    c_Package = 0x08,      
                    c_Function = 0x10,     
                    c_File = 0x20,         
                    c_Line = 0x40,         
                    c_Timestamp = 0x80,    
                    c_NoVariables = 0x100, 
                  };

◆ ELogLevel

enum ELogLevel

Definition of the supported log levels.

In ascending order !

Enumerator
c_Debug	Debug: for code development.
c_Info	Info: for informational messages, e.g. about opened files, processed events, etc.
c_Result	Result: for informational summary messages, e.g. about number of selected events
c_Warning	Warning: for potential problems that the user should pay attention to.
c_Error	Error: for things that went wrong and have to be fixed.
c_Fatal	Fatal: for situations were the program execution can not be continued.
c_Default	Default: use globally configured log level.

Definition at line 26 of file LogConfig.h.

                   { c_Debug,   
                     c_Info,    
                     c_Result,  
                     c_Warning, 
                     c_Error,   
                     c_Fatal,   
                     c_Default  
                   };

◆ ELogRealm

enum ELogRealm

Definition of the supported execution realms.

Enumerator
c_None	No specific realm.
c_Online	Online data taking.
c_Production	Data production jobs.

Definition at line 48 of file LogConfig.h.

                   { c_None,          
                     c_Online,        
                     c_Production     
                   };

Constructor & Destructor Documentation

◆ LogConfig()

LogConfig	(	LogConfig::ELogLevel	logLevel = `c_Default`,
		int	debugLevel = `c_DefaultDebugLevel`
	)

The LogConfig constructor.

Parameters

logLevel	The log level.
debugLevel	The debug level.

Definition at line 17 of file LogConfig.cc.

                                                                :
  m_logLevel(logLevel),
  m_debugLevel(debugLevel),
  m_abortLevel(LogConfig::c_Fatal),
  m_logInfo{0}
{}

Member Function Documentation

◆ getAbortLevel()

ELogLevel getAbortLevel ( ) const

inline

Returns the configured abort level.

Returns: Returns the configured abort level.

Definition at line 119 of file LogConfig.h.

119{return m_abortLevel; }

◆ getDebugLevel()

int getDebugLevel ( ) const

inline

Returns the configured debug messaging level.

Returns: Returns the configured debug messaging level.

Definition at line 105 of file LogConfig.h.

105{return m_debugLevel; }

◆ getLogInfo()

unsigned int getLogInfo ( ELogLevel logLevel ) const

inline

Returns the configured log information for the given level.

Returns: Returns the configured log information.

Definition at line 134 of file LogConfig.h.

134{return m_logInfo[logLevel]; }

◆ getLogLevel()

ELogLevel getLogLevel ( ) const

inline

Returns the configured log level.

Returns: Returns the configured log level.

Definition at line 91 of file LogConfig.h.

91{return m_logLevel; }

◆ logLevelToString()

const char * logLevelToString ( LogConfig::ELogLevel logLevelType )

static

Converts a log level type to a string.

Parameters

logLevelType The type of the log level.

Returns: The string representation of the log level type.

Definition at line 42 of file LogConfig.cc.

{
  static const char* logLevelString[] = {"DEBUG", "INFO", "RESULT", "WARNING", "ERROR", "FATAL", "default"};
  return logLevelString[logLevelType];
}

◆ logRealmToString()

const char * logRealmToString ( LogConfig::ELogRealm realm )

static

Converts a log realm type to a string.

Parameters

realm The log realm.

Returns: The string representation of the log realm.

Definition at line 49 of file LogConfig.cc.

{
  static const char* logRealmString[] = {"none", "online", "production"};
  return logRealmString[realm];
}

◆ setAbortLevel()

void setAbortLevel ( ELogLevel abortLevel )

inline

Configure the abort level.

Parameters

abortLevel The abort log level.

Definition at line 112 of file LogConfig.h.

112{m_abortLevel = abortLevel; }

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inline

Configure the debug messaging level.

Parameters

debugLevel The debug level.

Definition at line 98 of file LogConfig.h.

98{m_debugLevel = debugLevel; }

◆ setLogInfo()

void setLogInfo	(	ELogLevel	logLevel,
		unsigned int	logInfo
	)

inline

Configure the printed log information for the given level.

Parameters

logLevel	The log level.
logInfo	The log information that should be printed.

Definition at line 127 of file LogConfig.h.

127{m_logInfo[logLevel] = logInfo; }

◆ setLogLevel()

void setLogLevel ( ELogLevel logLevel )

Configure the log level.

Parameters

logLevel The log level.

Definition at line 25 of file LogConfig.cc.

{
  if (logLevel == c_Fatal) {
    // we want to show a warning that this is not possible but the log level
    // might already be on error hiding the warning completely. We don't want
    // to emit an error because this might abort processing. So force a warning
    // message.
    Belle2::LogSystem::Instance().sendMessage(Belle2::LogMessage(c_Warning,
                                              "Error messages cannot be switched off. The log level is set to ERROR instead of FATAL.",
                                              PACKAGENAME(), FUNCTIONNAME(), __FILE__, __LINE__, 0));
    logLevel = c_Error;
  }
  if (logLevel == c_Debug) Belle2::LogSystem::enableDebug();
  m_logLevel = logLevel;
}

Member Data Documentation

◆ c_DefaultDebugLevel

const int c_DefaultDebugLevel = 10

static

Default debug level.

Definition at line 53 of file LogConfig.h.

◆ m_abortLevel

ELogLevel m_abortLevel

private

The log level at which the execution should be stopped.

Definition at line 141 of file LogConfig.h.

◆ m_debugLevel

int m_debugLevel

private

The debug messaging level.

Definition at line 140 of file LogConfig.h.

◆ m_logInfo

unsigned int m_logInfo[c_Default]

private

The kind of printed information per log level.

(ORed combination of LogConfig::ELogInfo flags).

Definition at line 143 of file LogConfig.h.

◆ m_logLevel

ELogLevel m_logLevel

private

The log messaging level.

Defined as int for the parameter handling.

Definition at line 139 of file LogConfig.h.

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

framework/logging/include/LogConfig.h
framework/logging/src/LogConfig.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ELogInfo

◆ ELogLevel

◆ ELogRealm

Constructor & Destructor Documentation

◆ LogConfig()

Member Function Documentation

◆ getAbortLevel()

◆ getDebugLevel()

◆ getLogInfo()

◆ getLogLevel()

◆ logLevelToString()

◆ logRealmToString()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setLogInfo()

◆ setLogLevel()

Member Data Documentation

◆ c_DefaultDebugLevel

◆ m_abortLevel

◆ m_debugLevel

◆ m_logInfo

◆ m_logLevel