lsst.log::Log Class Reference

#include <Log.h>

Static Public Member Functions
static void	initLog (void)
static void	configure (void)
static void	configure (std::string const &filename)
static void	configure_prop (std::string const &properties)
static std::string	getDefaultLoggerName (void)
static log4cxx::LoggerPtr	getLogger (log4cxx::LoggerPtr logger)
static log4cxx::LoggerPtr	getLogger (std::string const &loggername)
static void	pushContext (std::string const &name)
static void	popContext (void)
static void	MDC (std::string const &key, std::string const &value)
static void	MDCRemove (std::string const &key)
static void	setLevel (log4cxx::LoggerPtr logger, int level)
static void	setLevel (std::string const &loggername, int level)
static int	getLevel (log4cxx::LoggerPtr logger)
static int	getLevel (std::string const &loggername)
static bool	isEnabledFor (log4cxx::LoggerPtr logger, int level)
static bool	isEnabledFor (std::string const &loggername, int level)
static void	vlog (log4cxx::LoggerPtr logger, log4cxx::LevelPtr level, std::string const &filename, std::string const &funcname, unsigned int lineno, char const *fmt, va_list args)
static void	log (std::string const &loggername, log4cxx::LevelPtr level, std::string const &filename, std::string const &funcname, unsigned int lineno, char const *fmt,...)
static void	log (log4cxx::LoggerPtr logger, log4cxx::LevelPtr level, std::string const &filename, std::string const &funcname, unsigned int lineno, char const *fmt,...)

Static Public Attributes
static log4cxx::LoggerPtr	defaultLogger = log4cxx::Logger::getRootLogger()

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 489 of file Log.h.

Member Function Documentation

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

static

Configures log4cxx and initializes logging system by invoking initLog(). Uses either default configuration or log4cxx basic configuration. Default 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 log4cxx BasicConfigurator class is used to configure, 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 "%-4r [%t] %-5p %c %x - %m%n".

Definition at line 119 of file Log.cc.

                    {
    // TODO: does resetConfiguration() remove existing appenders?
    log4cxx::BasicConfigurator::resetConfiguration();

    // if LSST_LOG_CONFIG is set then use that file
    if (const char* env = getenv(::configEnv)) {
        if (env[0] and access(env, R_OK) == 0) {
            configure(env);
            return;
        }
    }

    // Do basic configuration (only if not configured already?)
    log4cxx::LoggerPtr rootLogger = log4cxx::Logger::getRootLogger();
    if (rootLogger->getAllAppenders().size() == 0) {
        log4cxx::BasicConfigurator::configure();
    }
    initLog();
}

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

static

Configures log4cxx using FILENAME and initializes logging module by invoking initLog(). If FILENAME 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 156 of file Log.cc.

                                             {
    // TODO: does resetConfiguration() remove existing appenders?
    log4cxx::BasicConfigurator::resetConfiguration();
    if (getFileExtension(filename).compare(".xml") == 0) {
        log4cxx::xml::DOMConfigurator::configure(filename);
    } else {
        log4cxx::PropertyConfigurator::configure(filename);
    }
    initLog();
}

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 173 of file Log.cc.

                                                    {
    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);
    initLog();
}

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

static

Get the current default logger name.

Returns

String containing the default logger name.

Definition at line 185 of file Log.cc.

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

int lsst.log::Log::getLevel ( log4cxx::LoggerPtr  logger )

static

Retrieve the logging threshold for LOGGER.

Returns

int Indicating the logging threshold.

Parameters

logger

Logger with threshold to return.

Definition at line 301 of file Log.cc.

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

int lsst.log::Log::getLevel ( std::string const &  loggername )

static

Retrieve the logging threshold for the logger name LOGGERNAME.

Returns

Int indicating the logging threshold.

Parameters

loggername

Name of logger with threshold to return.

Definition at line 315 of file Log.cc.

                                             {
    return getLevel(getLogger(loggername));
}

log4cxx::LoggerPtr lsst.log::Log::getLogger ( log4cxx::LoggerPtr  logger )

static

This method exists solely to simplify the LOGF macro. It merely returns the argument LOGGER.

Returns

log4cxx::LoggerPtr passed in.

Parameters

logger

log4cxx::LoggerPtr to return.

Definition at line 199 of file Log.cc.

                                                       {
    return logger;
}

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

static

Returns a pointer to the log4cxx logger object associated with LOGGERNAME.

Returns

log4cxx::LoggerPtr corresponding to LOGGERNAME.

Parameters

loggername

Name of logger to return.

Definition at line 209 of file Log.cc.

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

void lsst.log::Log::initLog ( void  )

static

Initializes logging module (e.g. default logger and logging context).

Definition at line 104 of file Log.cc.

                  {
    // Default logger initially set to root logger
    defaultLogger = log4cxx::Logger::getRootLogger();
}

bool lsst.log::Log::isEnabledFor ( log4cxx::LoggerPtr  logger, int  level  )

static

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

Returns

Bool indicating whether or not logger is enabled.

Parameters

logger	Logger being queried.
level	Logging threshold to check.

Definition at line 326 of file Log.cc.

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

bool lsst.log::Log::isEnabledFor ( std::string const &  loggername, int  level  )

static

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

Returns

Bool indicating whether or not logger is enabled.

Parameters

loggername	Name of logger being queried.
level	Logging threshold to check.

Definition at line 341 of file Log.cc.

                                                             {
    return isEnabledFor(getLogger(loggername), level);
}

void lsst.log::Log::log ( std::string const &  loggername, log4cxx::LevelPtr  level, std::string const &  filename, std::string const &  funcname, unsigned int  lineno, char const *  fmt,   ...  )

static

Parameters

loggername	name of logger
level	message level
filename	source filename
funcname	source function name
lineno	source line number
fmt	message format string

Definition at line 360 of file Log.cc.

               {
    va_list args;
    va_start(args, fmt);
    vlog(getLogger(loggername), level, filename, funcname, lineno, fmt, args);
}

void lsst.log::Log::log ( log4cxx::LoggerPtr  logger, log4cxx::LevelPtr  level, std::string const &  filename, std::string const &  funcname, unsigned int  lineno, char const *  fmt,   ...  )

static

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

Parameters

logger	the logger
level	message level
filename	source filename
funcname	source function name
lineno	source line number
fmt	message format string

Definition at line 376 of file Log.cc.

               {
    va_list args;
    va_start(args, fmt);
    vlog(logger, level, filename, funcname, lineno, fmt, args);
}

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 266 of file Log.cc.

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

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 274 of file Log.cc.

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

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

static

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

Definition at line 248 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 221 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 ( log4cxx::LoggerPtr  logger, int  level  )

static

Set the logging threshold for LOGGER to LEVEL.

Parameters

logger	Logger with threshold to adjust.
level	New logging threshold.

Definition at line 283 of file Log.cc.

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

void lsst.log::Log::setLevel ( std::string const &  loggername, int  level  )

static

Set the logging threshold for the logger named LOGGERNAME to LEVEL.

Parameters

loggername	Name of logger with threshold to adjust.
level	New logging threshold.

Definition at line 292 of file Log.cc.

                                                         {
    setLevel(getLogger(loggername), level);
}

void lsst.log::Log::vlog ( log4cxx::LoggerPtr  logger, log4cxx::LevelPtr  level, std::string const &  filename, std::string const &  funcname, unsigned int  lineno, char const *  fmt, va_list  args  )

static

Parameters

logger	the logger
level	message level
filename	source filename
funcname	source function name
lineno	source line number
fmt	message format string
args	message arguments

Definition at line 345 of file Log.cc.

                {
    char msg[MAX_LOG_MSG_LEN];
    vsnprintf(msg, MAX_LOG_MSG_LEN, fmt, args);
    logger->forcedLog(level, msg, log4cxx::spi::LocationInfo(filename.c_str(),
                                                             funcname.c_str(),
                                                             lineno));
}

Member Data Documentation

log4cxx::LoggerPtr lsst.log::Log::defaultLogger = log4cxx::Logger::getRootLogger()

static

Reference to the defaultLogger used by LOG* macros.

Definition at line 491 of file Log.h.

---

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

• /home/lsstsw/stack/Linux64/log/11.0.rc2+7/include/lsst/log/Log.h
• /home/lsstsw/stack/Linux64/log/11.0.rc2+7/src/Log.cc