lsst::log::Log Class Reference

This static class includes a variety of methods for interacting with the the logging module. More...

#include <Log.h>

Public Member Functions
	Log ()
bool	isDebugEnabled () const
	Check whether the logger is enabled for the DEBUG Level. More...
bool	isErrorEnabled () const
	Check whether the logger is enabled for the ERROR Level. More...
bool	isFatalEnabled () const
	Check whether the logger is enabled for the FATAL Level. More...
bool	isInfoEnabled () const
	Check whether the logger is enabled for the INFO Level. More...
bool	isTraceEnabled () const
	Check whether the logger is enabled for the TRACE Level. More...
bool	isWarnEnabled () const
	Check whether the logger is enabled for the WARN Level. More...
std::string	getName () const
	Get the logger name associated with the Log object. More...
void	setLevel (int level)
	Set the logging threshold to LEVEL. More...
int	getLevel () const
	Retrieve the logging threshold. More...
bool	isEnabledFor (int level) const
	Return whether the logging threshold of the logger is less than or equal to LEVEL. More...
void	log (log4cxx::LevelPtr level, log4cxx::spi::LocationInfo const &location, char const *fmt,...)
	Method used by LOG_INFO and similar macros to process a log message with variable arguments along with associated metadata. More...
void	logMsg (log4cxx::LevelPtr level, log4cxx::spi::LocationInfo const &location, std::string const &msg)
	Method used by LOGS_INFO and similar macros to process a log message. More...

Static Public Member Functions
static Log	getDefaultLogger ()
	Return default logger instance, same as default constructor. More...
static std::string	getDefaultLoggerName ()
	Get the current default logger name. More...
static void	configure ()
	Explicitly configures log4cxx and initializes logging system. More...
static void	configure (std::string const &filename)
	Configures log4cxx from specified file. More...
static void	configure_prop (std::string const &properties)
	Configures log4cxx using a string containing the list of properties, equivalent to configuring from a file containing the same content but without creating temporary files. More...
static Log	getLogger (Log const &logger)
static Log	getLogger (std::string const &loggername)
	Returns logger object for a given name. More...
static void	pushContext (std::string const &name)
	Pushes NAME onto the global hierarchical default logger name. More...
static void	popContext ()
	Pops the last pushed name off the global hierarchical default logger name. More...
static void	MDC (std::string const &key, std::string const &value)
	Places a KEY/VALUE pair in the Mapped Diagnostic Context (MDC) for the current thread. More...
static void	MDCRemove (std::string const &key)
	Remove the value associated with KEY within the MDC. More...
static int	MDCRegisterInit (std::function< void()> function)

Private Member Functions
	Log (log4cxx::LoggerPtr const &logger)
	Construct a Log using a LOG4CXX logger. More...

Static Private Member Functions
static log4cxx::LoggerPtr const &	_defaultLogger (log4cxx::LoggerPtr const &newDefault=log4cxx::LoggerPtr())
	Returns default LOG4CXX logger. More...

Private Attributes
log4cxx::LoggerPtr	_logger

Detailed Description

This static class includes a variety of methods for interacting with the the logging module.

These methods are not meant for direct use. Rather, they are used by the LOG* macros and the SWIG interface declared in logInterface.h.

Definition at line 723 of file Log.h.

Constructor & Destructor Documentation

lsst::log::Log::Log ( )

inline

Definition at line 732 of file Log.h.

: _logger(_defaultLogger()) { }

lsst::log::Log::Log ( log4cxx::LoggerPtr const &  logger )

inlineprivate

Construct a Log using a LOG4CXX logger.

The default constructor is called to ensure the default logger is initialized and LOG4CXX is configured.

Definition at line 802 of file Log.h.

: Log() { _logger = logger; }

Member Function Documentation

log4cxx::LoggerPtr const & lsst::log::Log::_defaultLogger ( log4cxx::LoggerPtr const &  newDefault = log4cxx::LoggerPtr() )

staticprivate

Returns default LOG4CXX logger.

Parameters

newDefault

if non-zero then default is set to this value first.

Definition at line 152 of file Log.cc.

                                                                              {
    bool isNull = newDefault == log4cxx::LoggerPtr();

    // initialize on the first call (skip initialization if someone else did that)
    static log4cxx::LoggerPtr _default(::log4cxxInit(!isNull));

    if (!isNull) {
        _default = newDefault;
    }
    return _default;
}

void lsst::log::Log::configure ( )

static

Explicitly configures log4cxx and initializes logging system.

Configuration can be specified via environment variable LSST_LOG_CONFIG, if it is set and specifies existing file name then this file name is used for configuration. Otherwise pre-defined configuration is used, which is hardwired to add to the root logger a ConsoleAppender. In this case, the output will be formatted using a PatternLayout set to the pattern "%c %p: %m%n".

Definition at line 173 of file Log.cc.

                    {

    // This removes all defined appenders, resets level to DEBUG,
    // existing loggers are not deleted, only reset.
    log4cxx::BasicConfigurator::resetConfiguration();

    // Do default configuration (only if not configured already?)
    ::defaultConfig();

    // reset default logger to the root logger
    _defaultLogger(log4cxx::Logger::getRootLogger());
}

void lsst::log::Log::configure ( std::string const &  filename )

static

Configures log4cxx from specified file.

If file name ends with ".xml", it is passed to log4cxx::xml::DOMConfigurator::configure(). Otherwise, it assumed to be a log4j Java properties file and is passed to log4cxx::PropertyConfigurator::configure(). See http://logging.apache.org/log4cxx/usage.html for additional details.

Parameters

filename

Path to configuration file.

Definition at line 196 of file Log.cc.

                                             {
    // This removes all defined appenders, resets level to DEBUG,
    // existing loggers are not deleted, only reset.
    log4cxx::BasicConfigurator::resetConfiguration();

    ::configFromFile(filename);

    // reset default logger to the root logger
    _defaultLogger(log4cxx::Logger::getRootLogger());
}

void lsst::log::Log::configure_prop ( std::string const &  properties )

static

Configures log4cxx using a string containing the list of properties, equivalent to configuring from a file containing the same content but without creating temporary files.

Parameters

properties

Configuration properties.

Definition at line 213 of file Log.cc.

                                                    {
    // This removes all defined appenders, resets level to DEBUG,
    // existing loggers are not deleted, only reset.
    log4cxx::BasicConfigurator::resetConfiguration();

    std::vector<unsigned char> data(properties.begin(), properties.end());
    log4cxx::helpers::InputStreamPtr inStream(new log4cxx::helpers::ByteArrayInputStream(data));
    log4cxx::helpers::Properties prop;
    prop.load(inStream);
    log4cxx::PropertyConfigurator::configure(prop);

    // reset default logger to the root logger
    _defaultLogger(log4cxx::Logger::getRootLogger());
}

static Log lsst::log::Log::getDefaultLogger ( )

inlinestatic

Return default logger instance, same as default constructor.

Definition at line 765 of file Log.h.

{ return Log(_defaultLogger()); }

std::string lsst::log::Log::getDefaultLoggerName ( )

static

Get the current default logger name.

Returns

String containing the default logger name.

Definition at line 231 of file Log.cc.

                                    {
    return getDefaultLogger().getName();
}

int lsst::log::Log::getLevel

(

)

const

Retrieve the logging threshold.

Returns

int Indicating the logging threshold.

Definition at line 349 of file Log.cc.

                        {
    log4cxx::LevelPtr level = _logger->getLevel();
    int levelno = -1;
    if (level != NULL) {
        levelno = level->toInt();
    }
    return levelno;
}

static Log lsst::log::Log::getLogger ( Log const &  logger )

inlinestatic

Definition at line 772 of file Log.h.

{ return logger; }

Log lsst::log::Log::getLogger ( std::string const &  loggername )

static

Returns logger object for a given name.

If name is empty then current logger is returned and not a root logger.

Parameters

loggername

Name of logger to return.

Returns

Log instance corresponding to logger name.

Definition at line 254 of file Log.cc.

                                              {
    if (loggername.empty()){
        return getDefaultLogger();
    } else {
        return Log(log4cxx::Logger::getLogger(loggername));
    }
}

std::string lsst::log::Log::getName

(

)

const

Get the logger name associated with the Log object.

Returns

String containing the logger name.

Definition at line 238 of file Log.cc.

                             {
    std::string name = _logger->getName();
    if (name == "root") {
        name.clear();
    }
    return name;
}

bool lsst::log::Log::isDebugEnabled ( ) const

inline

Check whether the logger is enabled for the DEBUG Level.

Definition at line 737 of file Log.h.

{ return _logger->isDebugEnabled(); }

bool lsst::log::Log::isEnabledFor

(

int

level

)

const

Return whether the logging threshold of the logger is less than or equal to LEVEL.

Returns

Bool indicating whether or not logger is enabled.

Parameters

level

Logging threshold to check.

Definition at line 364 of file Log.cc.

                                      {
    if (_logger->isEnabledFor(log4cxx::Level::toLevel(level))) {
        return true;
    } else {
        return false;
    }
}

bool lsst::log::Log::isErrorEnabled ( ) const

inline

Check whether the logger is enabled for the ERROR Level.

Definition at line 741 of file Log.h.

{ return _logger->isErrorEnabled(); }

bool lsst::log::Log::isFatalEnabled ( ) const

inline

Check whether the logger is enabled for the FATAL Level.

Definition at line 745 of file Log.h.

{ return _logger->isFatalEnabled(); }

bool lsst::log::Log::isInfoEnabled ( ) const

inline

Check whether the logger is enabled for the INFO Level.

Definition at line 749 of file Log.h.

{ return _logger->isInfoEnabled(); }

bool lsst::log::Log::isTraceEnabled ( ) const

inline

Check whether the logger is enabled for the TRACE Level.

Definition at line 753 of file Log.h.

{ return _logger->isTraceEnabled(); }

bool lsst::log::Log::isWarnEnabled ( ) const

inline

Check whether the logger is enabled for the WARN Level.

Definition at line 757 of file Log.h.

{ return _logger->isWarnEnabled(); }

void lsst::log::Log::log	(	log4cxx::LevelPtr	level,
		log4cxx::spi::LocationInfo const &	location,
		char const *	fmt,
			...
	)

Method used by LOG_INFO and similar macros to process a log message with variable arguments along with associated metadata.

Parameters

level	message level
location	message origin location
fmt	message format string

Definition at line 375 of file Log.cc.

               {
    va_list args;
    va_start(args, fmt);
    char msg[MAX_LOG_MSG_LEN];
    vsnprintf(msg, MAX_LOG_MSG_LEN, fmt, args);
    logMsg(level, location, msg);
}

void lsst::log::Log::logMsg	(	log4cxx::LevelPtr	level,
		log4cxx::spi::LocationInfo const &	location,
		std::string const &	msg
	)

Method used by LOGS_INFO and similar macros to process a log message.

Parameters

level	message level
location	message origin location
msg	message string

Definition at line 389 of file Log.cc.

                   {

    // do one-time per-thread initialization, this was implemented
    // with thread_local initially but clang on OS X did not support it
    void *ptr = pthread_getspecific(::pthreadKey.key);
    if (ptr == nullptr) {

        // use pointer value as a flag, don't care where it points to
        ptr = static_cast<void*>(&::pthreadKey);
        pthread_setspecific(::pthreadKey.key, ptr);

        std::lock_guard<std::mutex> lock(mdcInitMutex);
                // call all functions in the MDC init list
        for (auto& fun: mdcInitFunctions) {
            fun();
        }
    }

    // forward everything to logger
    _logger->forcedLog(level, msg, location);
}

void lsst::log::Log::MDC ( std::string const &  key, std::string const &  value  )

static

Places a KEY/VALUE pair in the Mapped Diagnostic Context (MDC) for the current thread.

The VALUE may then be included in log messages by using the following the X conversion character within a pattern layout as X{KEY}.

Parameters

key	Unique key.
value	String value.

Definition at line 311 of file Log.cc.

                                                          {
    log4cxx::MDC::put(key, value);
}

int lsst::log::Log::MDCRegisterInit ( std::function< void()>  function )

static

Definition at line 323 of file Log.cc.

                                                     {

    std::lock_guard<std::mutex> lock(mdcInitMutex);

    // logMsg may have been called already in this thread, to make sure that
    // this function is executed in this thread call it explicitly
    function();

    // store function for later use
    ::mdcInitFunctions.push_back(std::move(function));

    // return arbitrary number
    return 1;
}

void lsst::log::Log::MDCRemove ( std::string const &  key )

static

Remove the value associated with KEY within the MDC.

Parameters

key	Key identifying value to remove.

Definition at line 319 of file Log.cc.

                                        {
    log4cxx::MDC::remove(key);
}

void lsst::log::Log::popContext ( )

static

Pops the last pushed name off the global hierarchical default logger name.

Definition at line 293 of file Log.cc.

                     {
    // switch to parent logger, this assumes that loggers are not
    // re-parented between calls to push and pop
    log4cxx::LoggerPtr parent = _defaultLogger()->getParent();
    // root logger does not have parent, stay at root instead
    if (parent) {
        _defaultLogger(parent);
    }
}

void lsst::log::Log::pushContext ( std::string const &  name )

static

Pushes NAME onto the global hierarchical default logger name.

Parameters

name	String to push onto logging context.

Definition at line 266 of file Log.cc.

                                           {
    // can't handle empty names
    if (name.empty()) {
        throw std::invalid_argument("lsst::log::Log::pushContext(): "
                "empty context name is not allowed");
    }
    // we do not allow multi-level context (logger1.logger2)
    if (name.find('.') != std::string::npos) {
        throw std::invalid_argument("lsst::log::Log::pushContext(): "
                "multi-level contexts are not allowed: " + name);
    }

    // Construct new default logger name
    std::string newName = _defaultLogger()->getName();
    if (newName == "root") {
        newName = name;
    } else {
        newName += ".";
        newName += name;
    }
    // Update defaultLogger
    _defaultLogger(log4cxx::Logger::getLogger(newName));
}

void lsst::log::Log::setLevel

(

int

level

)

Set the logging threshold to LEVEL.

Parameters

level

New logging threshold.

Definition at line 342 of file Log.cc.

                            {
    _logger->setLevel(log4cxx::Level::toLevel(level));
}

Member Data Documentation

log4cxx::LoggerPtr lsst::log::Log::_logger

private

Definition at line 804 of file Log.h.

---

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

• /home/lsstsw/jenkins/release/lsstsw/stack/Linux64/log/12.1-5-gc2189d7+4/include/lsst/log/Log.h
• /home/lsstsw/jenkins/release/lsstsw/stack/Linux64/log/12.1-5-gc2189d7+4/src/Log.cc