The LogMessage class. More...

#include <LogMessage.h>

Classes
struct	TextHasher
	Helper struct to hash and compare messages only by log level and message content. More...

Public Member Functions
	LogMessage (LogConfig::ELogLevel logLevel, const std::string &message, const char *package, std::string function, std::string file, unsigned int line, int debugLevel=0)
	The LogMessage constructor.

	LogMessage (LogConfig::ELogLevel logLevel, LogVariableStream &&messageStream, const char *package, std::string function, std::string file, unsigned int line, int debugLevel=0)
	The LogMessage constructor taking a LogVariableStream which can contains name/value pairs.

	LogMessage (LogMessage &&)=default
	Provide move constructor.

	LogMessage (LogMessage const &lm)=default
	Provide copy-constructor.

bool	operator== (const LogMessage &message) const
	Compares two messages.

bool	operator!= (const LogMessage &message) const
	Check for inequality.

LogMessage &	operator= (const LogMessage &lvs)=default
	Custom assignment-operator, thanks to stringsream's incompetence ...

LogConfig::ELogLevel	getLogLevel () const
	Returns the log level of the message.

const std::string &	getPackage () const
	Returns the package where the message was sent from.

const std::string	getMessage () const
	Returns the message text.

void	setModule (const std::string &module)
	Configure which information should be printed.

void	setLogInfo (unsigned int logInfo)
	Configure which information should be printed.

void	setCount (int count)
	Set the number of occurrences.

std::ostream &	print (std::ostream &out) const
	Generate output stream.

std::string	toJSON (bool complete) const
	Return a json string for the log message.

const std::vector< LogVar > &	getLogVariables () const
	Return a reference to the log variables associated with this message.

Private Attributes
LogConfig::ELogLevel	m_logLevel
	The log level of the message.

LogVariableStream	m_message
	The message stream which should be sent.

std::string	m_module
	The module name where the message was sent from.

std::string	m_package
	The package name where the message was sent from.

std::string	m_function
	The function name where the message was sent from.

std::string	m_file
	The file name where the message was sent from.

unsigned int	m_line
	The line number in the source code where the message was sent from.

int	m_debugLevel
	The debug level for messages with level=c_Debug.

unsigned int	m_logInfo
	kind of information to show (ORed combination of LogConfig::ELogInfo flags).

int	m_count
	Number of occurrences of the same message.

Detailed Description

The LogMessage class.

This class encapsulates a logging message.

Definition at line 29 of file LogMessage.h.

Constructor & Destructor Documentation

◆ LogMessage() [1/2]

LogMessage	(	LogConfig::ELogLevel	logLevel,
		const std::string &	message,
		const char *	package,
		std::string	function,
		std::string	file,
		unsigned int	line,
		int	debugLevel = `0`
	)

The LogMessage constructor.

Parameters

logLevel	The log level of the message (e.g. debug, info, warning, error, fatal).
message	The message string which should be send. This will be internally converted to a LogVariableStream with the text message and 0 variables.
package	The package name where the message was sent from (can be NULL)
function	The function name where the message was sent from.
file	The file name where the message was sent from.
line	The line number in the source code where the message was sent from.
debugLevel	The debug level of the message if the logLevel is c_Debug

Definition at line 25 of file LogMessage.cc.

                                                                                                :
  m_logLevel(logLevel),
  m_message(message),
  m_module(""),
  m_package(package ? package : ""),
  m_function(std::move(function)),
  m_file(std::move(file)),
  m_line(line),
  m_debugLevel(debugLevel),
  m_logInfo(0),
  m_count(0)
{
}

◆ LogMessage() [2/2]

LogMessage	(	LogConfig::ELogLevel	logLevel,
		LogVariableStream &&	messageStream,
		const char *	package,
		std::string	function,
		std::string	file,
		unsigned int	line,
		int	debugLevel = `0`
	)

The LogMessage constructor taking a LogVariableStream which can contains name/value pairs.

Parameters

logLevel	The log level of the message (e.g. debug, info, warning, error, fatal).
messageStream	The LogVariableStream which should be send.
package	The package name where the message was sent from (can be NULL)
function	The function name where the message was sent from.
file	The file name where the message was sent from.
line	The line number in the source code where the message was sent from.
debugLevel	The debug level of the message if the logLevel is c_Debug

Definition at line 40 of file LogMessage.cc.

                                                                                                :
  m_logLevel(logLevel),
  m_message(std::move(messageStream)),
  m_module(""),
  m_package(package ? package : ""),
  m_function(std::move(function)),
  m_file(std::move(file)),
  m_line(line),
  m_debugLevel(debugLevel),
  m_logInfo(0),
  m_count(0)
{
  m_message.adjustLogLevel(m_logLevel);
}

Member Function Documentation

◆ getLogLevel()

LogConfig::ELogLevel getLogLevel ( ) const

inline

Returns the log level of the message.

Returns: Returns the log level of the message.

Definition at line 91 of file LogMessage.h.

91{return m_logLevel; }

◆ getLogVariables()

const std::vector< LogVar > & getLogVariables ( ) const

inline

Return a reference to the log variables associated with this message.

Definition at line 136 of file LogMessage.h.

136{ return m_message.getVariables(); }

LogVariableStream::getVariables

const std::vector< LogVar > & getVariables() const

Return the list of all defined variables.

Definition: LogVariableStream.h:259

◆ getMessage()

const std::string getMessage ( ) const

inline

Returns the message text.

Returns: Returns the message text;

Definition at line 105 of file LogMessage.h.

105{ return m_message.str(); }

LogVariableStream::str

std::string str(bool showVariables=true) const

Return the content of the stream as string.

Definition: LogVariableStream.h:235

◆ getPackage()

const std::string & getPackage ( ) const

inline

Returns the package where the message was sent from.

Returns: Returns the package where the message was sent from.

Definition at line 98 of file LogMessage.h.

98{return m_package; }

◆ operator!=()

bool operator!= ( const LogMessage & message ) const

inline

Check for inequality.

Definition at line 79 of file LogMessage.h.

79{ return !(*this == message); }

◆ operator==()

bool operator== ( const LogMessage & message ) const

Compares two messages.

Returns: true if the message contents (including module, .cc line etc.) are equal.

Definition at line 57 of file LogMessage.cc.

{
  return ((m_logLevel == message.m_logLevel) &&
          (m_line == message.m_line) &&
          (m_message == message.m_message) &&
          (m_module == message.m_module) &&
          (m_package == message.m_package) &&
          (m_function == message.m_function) &&
          (m_file == message.m_file));
}

◆ print()

std::ostream & print ( std::ostream & out ) const

Generate output stream.

Parameters

out	The output stream.

Definition at line 128 of file LogMessage.cc.

{
  int logInfo = m_logInfo ? m_logInfo :
                (LogConfig::c_Timestamp | LogConfig::c_Level | LogConfig::c_Message | LogConfig::c_Module | LogConfig::c_Package |
                 LogConfig::c_Function | LogConfig::c_File | LogConfig::c_Line);
  if (logInfo & LogConfig::c_Timestamp) {
    static const double startClock = Utils::getClock();
    const auto flags = out.flags();
    const int oldprecision = out.precision(3);
    out << std::fixed << (Utils::getClock() - startClock) / Unit::s << ": ";
    out.precision(oldprecision);
    out.flags(flags);
  }
  if (logInfo & LogConfig::c_Level) {
    const std::string debugLevel = (m_logLevel == LogConfig::c_Debug) ? (":" + std::to_string(m_debugLevel)) : "";
    out << "[" << LogConfig::logLevelToString(m_logLevel) << debugLevel << "] ";
  }
  if (ProcHandler::EvtProcID() != -1) {
    //which process is this?
    out << "(" << ProcHandler::EvtProcID() << ") ";
  }
  if (logInfo & LogConfig::c_Message) {
    out << m_message.str(!(logInfo & LogConfig::c_NoVariables));
  }
  // if there is no module or package or similar there's no need to print them
  if (m_module.empty()) logInfo &= ~LogConfig::c_Module;
  if (m_package.empty()) logInfo &= ~LogConfig::c_Package;
  if (m_function.empty()) logInfo &= ~LogConfig::c_Function;
  // line number without filename is useless as well so disable both in one go
  if (m_file.empty()) logInfo &= ~(LogConfig::c_File | LogConfig::c_Line);
  // is there any location string left to print?
  bool printLocation = logInfo & (LogConfig::c_Module | LogConfig::c_Package | LogConfig::c_Function |
                                  LogConfig::c_File | LogConfig::c_Line);
  if (printLocation) {
    out << "  {";
  }
  if (logInfo & LogConfig::c_Module) {
    out << " module: " << m_module;
  }
  if (logInfo & LogConfig::c_Package) {
    out << " package: " << m_package;
  }
  if (logInfo & LogConfig::c_Function) {
    out << " function: " << m_function;
  }
  if (logInfo & LogConfig::c_File) {
    out << " @" << m_file;
  }
  if (logInfo & LogConfig::c_Line) {
    out  << ":" << m_line;
  }
  if (printLocation) {
    out << " }";
  }
  out << endl;
  return out;
}

◆ setCount()

void setCount ( int count )

inline

Set the number of occurrences.

Definition at line 120 of file LogMessage.h.

120{m_count = count; }

◆ setLogInfo()

void setLogInfo ( unsigned int logInfo )

inline

Configure which information should be printed.

Definition at line 115 of file LogMessage.h.

115{m_logInfo = logInfo; }

◆ setModule()

void setModule ( const std::string & module )

inline

Configure which information should be printed.

Definition at line 110 of file LogMessage.h.

110{m_module = module; }

◆ toJSON()

std::string toJSON ( bool complete ) const

Return a json string for the log message.

The returned string will be a json object containing the full log message on one line

Parameters

complete if true include all fields independent of the logInfo settings

Definition at line 68 of file LogMessage.cc.

{
  using namespace boost::property_tree::json_parser;
  std::stringstream buffer;
  static const double startClock = Utils::getClock();
  double time = (Utils::getClock() - startClock) / Unit::s;
  int logInfo = (m_logInfo and not complete) ? m_logInfo :
                (LogConfig::c_Timestamp | LogConfig::c_Level | LogConfig::c_Message | LogConfig::c_Module |
                 LogConfig::c_Package | LogConfig::c_Function | LogConfig::c_File | LogConfig::c_Line);
  // in JSON we always output level, independent of what the log info says, otherwise it is hard to parse
  buffer << R"({"level":")" << LogConfig::logLevelToString(m_logLevel) << '"';
  if (logInfo & LogConfig::c_Message) {
    buffer << R"(,"message":")" << create_escapes(m_message.getMessage()) << '"';
    const auto& vars = m_message.getVariables();
    if ((vars.size() > 0 or complete) and !(logInfo & LogConfig::c_NoVariables)) {
      buffer << ",\"variables\":{";
      bool first{true};
      for (const auto& v : vars) {
        if (!first) buffer << ",";
        buffer << '"' << create_escapes(v.getName()) << "\":\"" << create_escapes(v.getValue()) << '"';
        first = false;
      }
      buffer << '}';
    }
  }
  if (logInfo & LogConfig::c_Module)
    buffer << R"(,"module":")" << create_escapes(m_module) << '"';
  if (logInfo & LogConfig::c_Package)
    buffer << R"(,"package":")" << create_escapes(m_package) << '"';
  if (logInfo & LogConfig::c_Function)
    buffer << R"(,"function":")" << create_escapes(m_function) << '"';
  if (logInfo & LogConfig::c_File)
    buffer << R"(,"file":")" << create_escapes(m_file) << '"';
  if (logInfo & LogConfig::c_Line)
    buffer << ",\"line\":" << m_line;
  if (logInfo & LogConfig::c_Timestamp)
    buffer << ",\"timestamp\":" << std::fixed << std::setprecision(3) << time;
  if (ProcHandler::EvtProcID() != -1 or complete)
    buffer << ",\"proc\":" << ProcHandler::EvtProcID();
  if (complete) {
    buffer << ",\"count\":" << m_count;
    StoreObjPtr<EventMetaData> eventMetaData;
    if (eventMetaData.isValid()) {
      buffer << ",\"experiment\":" << eventMetaData->getExperiment();
      buffer << ",\"run\":" << eventMetaData->getRun();
      buffer << ",\"subrun\":" << eventMetaData->getSubrun();
      buffer << ",\"event\":" << eventMetaData->getEvent();
    }
    StoreObjPtr<ProcessStatistics> processStatistics("", DataStore::c_Persistent);
    if (processStatistics.isValid()) {
      const auto& stats = processStatistics->getGlobal();
      buffer << ",\"nruns\":" << int(stats.getCalls(ModuleStatistics::EStatisticCounters::c_BeginRun));
      buffer << ",\"nevents\":" << int(stats.getCalls());
    }
    buffer << ",\"initialize\":" << ((DataStore::Instance().getInitializeActive()) ? "true" : "false");
  }
  buffer << "}\n";
  return buffer.str();
}

Member Data Documentation

◆ m_count

int m_count

private

Number of occurrences of the same message.

Definition at line 168 of file LogMessage.h.

◆ m_debugLevel

int m_debugLevel

private

The debug level for messages with level=c_Debug.

Definition at line 165 of file LogMessage.h.

◆ m_file

std::string m_file

private

The file name where the message was sent from.

Definition at line 163 of file LogMessage.h.

◆ m_function

std::string m_function

private

The function name where the message was sent from.

Definition at line 162 of file LogMessage.h.

◆ m_line

unsigned int m_line

private

The line number in the source code where the message was sent from.

Definition at line 164 of file LogMessage.h.

◆ m_logInfo

unsigned int m_logInfo

private

kind of information to show (ORed combination of LogConfig::ELogInfo flags).

Definition at line 167 of file LogMessage.h.

◆ m_logLevel

LogConfig::ELogLevel m_logLevel

private

The log level of the message.

Definition at line 158 of file LogMessage.h.

◆ m_message

LogVariableStream m_message

private

The message stream which should be sent.

Definition at line 159 of file LogMessage.h.

◆ m_module

std::string m_module

private

The module name where the message was sent from.

Definition at line 160 of file LogMessage.h.

◆ m_package

std::string m_package

private

The package name where the message was sent from.

Definition at line 161 of file LogMessage.h.

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

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

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LogMessage() [1/2]

◆ LogMessage() [2/2]

Member Function Documentation

◆ getLogLevel()

◆ getLogVariables()

◆ getMessage()

◆ getPackage()

◆ operator!=()

◆ operator==()

◆ print()

◆ setCount()

◆ setLogInfo()

◆ setModule()

◆ toJSON()

Member Data Documentation

◆ m_count

◆ m_debugLevel

◆ m_file

◆ m_function

◆ m_line

◆ m_logInfo

◆ m_logLevel

◆ m_message

◆ m_module

◆ m_package