lsst::log::Log Class Reference

#include <Log.h>

Public Member Functions
bool	isDebugEnabled () const
bool	isErrorEnabled () const
bool	isFatalEnabled () const
bool	isInfoEnabled () const
bool	isTraceEnabled () const
bool	isWarnEnabled () const
std::string	getName () const
void	setLevel (int level)
int	getLevel () const
bool	isEnabledFor (int level) const
void	log (log4cxx::LevelPtr level, log4cxx::spi::LocationInfo const &location, char const *fmt,...)
void	logMsg (log4cxx::LevelPtr level, log4cxx::spi::LocationInfo const &location, std::string const &msg)

Static Public Member Functions
static Log	getDefaultLogger ()
	Return default logger instance, same as default constructor.
static std::string	getDefaultLoggerName ()
static void	configure ()
static void	configure (std::string const &filename)
static void	configure_prop (std::string const &properties)
static Log	getLogger (Log const &logger)
static Log	getLogger (std::string const &loggername)
static void	pushContext (std::string const &name)
static void	popContext ()
static void	MDC (std::string const &key, std::string const &value)
static void	MDCRemove (std::string const &key)
static int	MDCRegisterInit (std::function< void()> function)

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.

Member Function Documentation

configure() [1/2]

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".

configure() [2/2]

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.

configure_prop()

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.

getDefaultLoggerName()

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

static

Get the current default logger name.

Returns

String containing the default logger name.

getLevel()

int lsst::log::Log::getLevel

(

)

const

Retrieve the logging threshold.

Returns

int Indicating the logging threshold.

getLogger()

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.

getName()

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

(

)

const

Get the logger name associated with the Log object.

Returns

String containing the logger name.

isDebugEnabled()

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

inline

Check whether the logger is enabled for the DEBUG Level

isEnabledFor()

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.

isErrorEnabled()

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

inline

Check whether the logger is enabled for the ERROR Level

isFatalEnabled()

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

inline

Check whether the logger is enabled for the FATAL Level

isInfoEnabled()

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

inline

Check whether the logger is enabled for the INFO Level

isTraceEnabled()

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

inline

Check whether the logger is enabled for the TRACE Level

isWarnEnabled()

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

inline

Check whether the logger is enabled for the WARN Level

log()

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

logMsg()

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

MDC()

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}. Note that unlike log4cxx::MDC::put() this method overwrites any previously existing mapping.

Parameters

key	Unique key.
value	String value.

MDCRemove()

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.

popContext()

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

static

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

pushContext()

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.

setLevel()

void lsst::log::Log::setLevel

(

int

level

)

Set the logging threshold to LEVEL.

Parameters

level

New logging threshold.

---

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

• include/lsst/log/Log.h
• src/Log.cc