LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
Classes | Namespaces | Macros | Functions
Log.h File Reference

LSST DM logging module built on log4cxx. More...

#include <functional>
#include <sstream>
#include <stdarg.h>
#include <string>
#include <log4cxx/logger.h>
#include <boost/format.hpp>

Go to the source code of this file.

Classes

class  lsst::log::Log
 This static class includes a variety of methods for interacting with the the logging module. More...
 
class  lsst::log::LogMDCScope
 

Namespaces

 lsst
 A base class for image defects.
 
 lsst::log
 

Macros

#define LOG_CONFIG(filename)   lsst::log::Log::configure(filename)
 
#define LOG_CONFIG_PROP(string)   lsst::log::Log::configure_prop(string)
 
#define LOG_GET(logger)   lsst::log::Log::getLogger(logger)
 
#define LOG_GET_CHILD(logger, suffix)   lsst::log::Log::getLogger(logger).getChild(suffix)
 
#define LOG_MDC(key, value)   lsst::log::Log::MDC(key, value)
 
#define LOG_MDC_REMOVE(key)   lsst::log::Log::MDCRemove(key)
 
#define LOG_CONCAT_IMPL(a, b)   a ## b
 
#define LOG_CONCAT_IMPL2(a, b)   LOG_CONCAT_IMPL(a, b)
 
#define LOG_MDC_SCOPE(key, value)   lsst::log::LogMDCScope LOG_CONCAT_IMPL2(_log_mdc_scope_, __COUNTER__)(key, value);
 
#define LOG_MDC_INIT(func)   lsst::log::Log::MDCRegisterInit(std::function<void()>(func))
 
#define LOG_SET_LVL(logger, level)   lsst::log::Log::getLogger(logger).setLevel(level)
 
#define LOG_GET_LVL(logger)   lsst::log::Log::getLogger(logger).getLevel()
 
#define LOG_CHECK_LVL(logger, level)   lsst::log::Log::getLogger(logger).isEnabledFor(level)
 
#define LOG_CHECK_TRACE()   LOG4CXX_UNLIKELY(lsst::log::Log::getDefaultLogger().isTraceEnabled())
 
#define LOG_CHECK_DEBUG()   LOG4CXX_UNLIKELY(lsst::log::Log::getDefaultLogger().isDebugEnabled())
 
#define LOG_CHECK_INFO()   lsst::log::Log::getDefaultLogger().isInfoEnabled()
 
#define LOG_CHECK_WARN()   lsst::log::Log::getDefaultLogger().isWarnEnabled()
 
#define LOG_CHECK_ERROR()   lsst::log::Log::getDefaultLogger().isErrorEnabled()
 
#define LOG_CHECK_FATAL()   lsst::log::Log::getDefaultLogger().isFatalEnabled()
 
#define LOG(logger, level, message...)
 
#define LOG_TRACE(message...)
 
#define LOG_DEBUG(message...)
 
#define LOG_INFO(message...)
 
#define LOG_WARN(message...)
 
#define LOG_ERROR(message...)
 
#define LOG_FATAL(message...)
 
#define LOG_MESSAGE_VIA_STREAM_(logger, level, message)
 
#define LOGS(logger, level, message)
 
#define LOGS_TRACE(message)
 
#define LOGS_DEBUG(message)
 
#define LOGS_INFO(message)
 
#define LOGS_WARN(message)
 
#define LOGS_ERROR(message)
 
#define LOGS_FATAL(message)
 
#define LOGL_TRACE(logger, message...)
 
#define LOGL_DEBUG(logger, message...)
 
#define LOGL_INFO(logger, message...)
 
#define LOGL_WARN(logger, message...)
 
#define LOGL_ERROR(logger, message...)
 
#define LOGL_FATAL(logger, message...)
 
#define LOGLS_TRACE(logger, message)
 
#define LOGLS_DEBUG(logger, message)
 
#define LOGLS_INFO(logger, message)
 
#define LOGLS_WARN(logger, message)
 
#define LOGLS_ERROR(logger, message)
 
#define LOGLS_FATAL(logger, message)
 
#define LOG_LVL_TRACE   static_cast<int>(log4cxx::Level::TRACE_INT)
 
#define LOG_LVL_DEBUG   static_cast<int>(log4cxx::Level::DEBUG_INT)
 
#define LOG_LVL_INFO   static_cast<int>(log4cxx::Level::INFO_INT)
 
#define LOG_LVL_WARN   static_cast<int>(log4cxx::Level::WARN_INT)
 
#define LOG_LVL_ERROR   static_cast<int>(log4cxx::Level::ERROR_INT)
 
#define LOG_LVL_FATAL   static_cast<int>(log4cxx::Level::FATAL_INT)
 
#define LOG_LOGGER   lsst::log::Log
 

Functions

unsigned lsst::log::lwpID ()
 Function which returns LWP ID on platforms which support it. More...
 

Detailed Description

LSST DM logging module built on log4cxx.

Author
Bill Chickering Contact: chick.nosp@m.erin.nosp@m.g@cs..nosp@m.stan.nosp@m.ford..nosp@m.edu

Definition in file Log.h.

Macro Definition Documentation

◆ LOG

#define LOG (   logger,
  level,
  message... 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isEnabledFor(level)) { \
log.log(log4cxx::Level::toLevel(level), LOG4CXX_LOCATION, message); } \
} while (false)

Log a message using a varargs/printf style interface.

Parameters
loggerEither a logger name or a Log object.
levelLogging level associated with message.
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 241 of file Log.h.

◆ LOG_CHECK_DEBUG

#define LOG_CHECK_DEBUG ( )    LOG4CXX_UNLIKELY(lsst::log::Log::getDefaultLogger().isDebugEnabled())

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

Returns
Bool indicating whether or not logger is enabled.

Definition at line 193 of file Log.h.

◆ LOG_CHECK_ERROR

#define LOG_CHECK_ERROR ( )    lsst::log::Log::getDefaultLogger().isErrorEnabled()

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

Returns
Bool indicating whether or not logger is enabled.

Definition at line 220 of file Log.h.

◆ LOG_CHECK_FATAL

#define LOG_CHECK_FATAL ( )    lsst::log::Log::getDefaultLogger().isFatalEnabled()

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

Returns
Bool indicating whether or not logger is enabled.

Definition at line 229 of file Log.h.

◆ LOG_CHECK_INFO

#define LOG_CHECK_INFO ( )    lsst::log::Log::getDefaultLogger().isInfoEnabled()

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

Returns
Bool indicating whether or not logger is enabled.

Definition at line 202 of file Log.h.

◆ LOG_CHECK_LVL

#define LOG_CHECK_LVL (   logger,
  level 
)    lsst::log::Log::getLogger(logger).isEnabledFor(level)

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

Returns
Bool indicating whether or not logger is enabled.
Parameters
loggerEither a logger name or a Log object being queried.
levelLogging threshold to check.

Definition at line 175 of file Log.h.

◆ LOG_CHECK_TRACE

#define LOG_CHECK_TRACE ( )    LOG4CXX_UNLIKELY(lsst::log::Log::getDefaultLogger().isTraceEnabled())

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

Returns
Bool indicating whether or not logger is enabled.

Definition at line 184 of file Log.h.

◆ LOG_CHECK_WARN

#define LOG_CHECK_WARN ( )    lsst::log::Log::getDefaultLogger().isWarnEnabled()

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

Returns
Bool indicating whether or not logger is enabled.

Definition at line 211 of file Log.h.

◆ LOG_CONCAT_IMPL

#define LOG_CONCAT_IMPL (   a,
  b 
)    a ## b

Definition at line 119 of file Log.h.

◆ LOG_CONCAT_IMPL2

#define LOG_CONCAT_IMPL2 (   a,
  b 
)    LOG_CONCAT_IMPL(a, b)

Definition at line 120 of file Log.h.

◆ LOG_CONFIG

#define LOG_CONFIG (   filename)    lsst::log::Log::configure(filename)

Configures log4cxx and initializes logging module.

Parameters
filenamePath to configuration file.

Definition at line 53 of file Log.h.

◆ LOG_CONFIG_PROP

#define LOG_CONFIG_PROP (   string)    lsst::log::Log::configure_prop(string)

Configures log4cxx from a string containing list of properties. This is equivalent to configuring with a file name containing the same data as a string.

Note
Use of this macro will likely produce hard-coded configuration which is not advised for general-use code. It may be useful where pre-defined hard-coded configuration is necessary, e.g. in unit tests.
Parameters
stringList of properties (lines separated by new line character)

Definition at line 67 of file Log.h.

◆ LOG_DEBUG

#define LOG_DEBUG (   message...)
Value:
do { \
lsst::log::Log log; \
if (LOG4CXX_UNLIKELY(log.isDebugEnabled())) { \
log.log(log4cxx::Level::getDebug(), LOG4CXX_LOCATION, message); } \
} while (false)

Log a debug-level message to the default logger using a varargs/printf style interface.

Parameters
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 271 of file Log.h.

◆ LOG_ERROR

#define LOG_ERROR (   message...)
Value:
do { \
lsst::log::Log log; \
if (log.isErrorEnabled()) { \
log.log(log4cxx::Level::getError(), LOG4CXX_LOCATION, message); } \
} while (false)

Log a error-level message to the default logger using a varargs/printf style interface.

Parameters
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 316 of file Log.h.

◆ LOG_FATAL

#define LOG_FATAL (   message...)
Value:
do { \
lsst::log::Log log; \
if (log.isFatalEnabled()) { \
log.log(log4cxx::Level::getFatal(), LOG4CXX_LOCATION, message); } \
} while (false)

Log a fatal-level message to the default logger using a varargs/printf style interface.

Parameters
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 331 of file Log.h.

◆ LOG_GET

#define LOG_GET (   logger)    lsst::log::Log::getLogger(logger)

Returns a Log object associated with logger.

Returns
Log object corresponding to logger.
Parameters
loggerEither a logger name or a Log object.

Definition at line 76 of file Log.h.

◆ LOG_GET_CHILD

#define LOG_GET_CHILD (   logger,
  suffix 
)    lsst::log::Log::getLogger(logger).getChild(suffix)

Returns a Log object associated with descendant of a logger.

Returns
Log object corresponding to logger's descendant.
Parameters
loggerEither a logger name or a Log object.
suffixSuffix of a descendant.

Definition at line 86 of file Log.h.

◆ LOG_GET_LVL

#define LOG_GET_LVL (   logger)    lsst::log::Log::getLogger(logger).getLevel()

Retrieve the logging threshold for LOGGER.

Returns
int Indicating the logging threshold.
Parameters
loggerEither a logger name or a Log object with threshold to return.

Definition at line 163 of file Log.h.

◆ LOG_INFO

#define LOG_INFO (   message...)
Value:
do { \
lsst::log::Log log; \
if (log.isInfoEnabled()) { \
log.log(log4cxx::Level::getInfo(), LOG4CXX_LOCATION, message); } \
} while (false)

Log a info-level message to the default logger using a varargs/printf style interface.

Parameters
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 286 of file Log.h.

◆ LOG_LOGGER

#define LOG_LOGGER   lsst::log::Log

Definition at line 704 of file Log.h.

◆ LOG_LVL_DEBUG

#define LOG_LVL_DEBUG   static_cast<int>(log4cxx::Level::DEBUG_INT)

Definition at line 698 of file Log.h.

◆ LOG_LVL_ERROR

#define LOG_LVL_ERROR   static_cast<int>(log4cxx::Level::ERROR_INT)

Definition at line 701 of file Log.h.

◆ LOG_LVL_FATAL

#define LOG_LVL_FATAL   static_cast<int>(log4cxx::Level::FATAL_INT)

Definition at line 702 of file Log.h.

◆ LOG_LVL_INFO

#define LOG_LVL_INFO   static_cast<int>(log4cxx::Level::INFO_INT)

Definition at line 699 of file Log.h.

◆ LOG_LVL_TRACE

#define LOG_LVL_TRACE   static_cast<int>(log4cxx::Level::TRACE_INT)

Definition at line 697 of file Log.h.

◆ LOG_LVL_WARN

#define LOG_LVL_WARN   static_cast<int>(log4cxx::Level::WARN_INT)

Definition at line 700 of file Log.h.

◆ LOG_MDC

#define LOG_MDC (   key,
  value 
)    lsst::log::Log::MDC(key, value)

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
keyUnique key.
valueString value.

Definition at line 98 of file Log.h.

◆ LOG_MDC_INIT

#define LOG_MDC_INIT (   func)    lsst::log::Log::MDCRegisterInit(std::function<void()>(func))

Register function for initialization of MDC. This function will be called for current thread and every new thread (but not for other existing threads) before any message is logged using one of the macros below. Its main purpose is to initialize MDC (using LOG_MDC macro). In some cases the function may be called more than once per thread.

This macro is thread safe, but typically it will be called from main thread before any other LOG macro.

Macro returns an integer number, the value is not specified, but this allows it to be used in one-time initialization constructs like:

@code
static int dummyMdcInit = LOG_MDC_INIT(some_init_func);
@endcode
Parameters
funcAny function object which takes no arguments and returns void.

Definition at line 143 of file Log.h.

◆ LOG_MDC_REMOVE

#define LOG_MDC_REMOVE (   key)    lsst::log::Log::MDCRemove(key)

Remove the value associated with KEY within the MDC.

Parameters
keyKey identifying value to remove.

Definition at line 106 of file Log.h.

◆ LOG_MDC_SCOPE

#define LOG_MDC_SCOPE (   key,
  value 
)    lsst::log::LogMDCScope LOG_CONCAT_IMPL2(_log_mdc_scope_, __COUNTER__)(key, value);

Places a KEY/VALUE pair in the Mapped Diagnostic Context (MDC) for the current thread, and restores previous KEY/VALUE on exit from a scope.

Parameters
keyUnique key.
valueString value.

Definition at line 121 of file Log.h.

◆ LOG_MESSAGE_VIA_STREAM_

#define LOG_MESSAGE_VIA_STREAM_ (   logger,
  level,
  message 
)
Value:
std::ostringstream stream_; \
stream_ << message; \
logger.logMsg(level, LOG4CXX_LOCATION, stream_.str())

Definition at line 340 of file Log.h.

◆ LOG_SET_LVL

#define LOG_SET_LVL (   logger,
  level 
)    lsst::log::Log::getLogger(logger).setLevel(level)

Set the logging threshold for LOGGER to LEVEL.

Parameters
loggerLogger with threshold to adjust.
levelNew logging threshold.

Definition at line 152 of file Log.h.

◆ LOG_TRACE

#define LOG_TRACE (   message...)
Value:
do { \
lsst::log::Log log; \
if (LOG4CXX_UNLIKELY(log.isTraceEnabled())) { \
log.log(log4cxx::Level::getTrace(), LOG4CXX_LOCATION, message); } \
} while (false)

Log a trace-level message to the default logger using a varargs/printf style interface.

Parameters
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 256 of file Log.h.

◆ LOG_WARN

#define LOG_WARN (   message...)
Value:
do { \
lsst::log::Log log; \
if (log.isWarnEnabled()) { \
log.log(log4cxx::Level::getWarn(), LOG4CXX_LOCATION, message); } \
} while (false)

Log a warn-level message to the default logger using a varargs/printf style interface.

Parameters
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 301 of file Log.h.

◆ LOGL_DEBUG

#define LOGL_DEBUG (   logger,
  message... 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (LOG4CXX_UNLIKELY(log.isDebugEnabled())) { \
log.log(log4cxx::Level::getDebug(), LOG4CXX_LOCATION, message); \
} \
} while (false)

Log a debug-level message using a varargs/printf style interface.

Parameters
loggerEither a logger name or a Log object.
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 505 of file Log.h.

◆ LOGL_ERROR

#define LOGL_ERROR (   logger,
  message... 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isErrorEnabled()) { \
log.log(log4cxx::Level::getError(), LOG4CXX_LOCATION, message); \
} \
} while (false)

Log a error-level message using a varargs/printf style interface.

Parameters
loggerEither a logger name or a Log object.
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 553 of file Log.h.

◆ LOGL_FATAL

#define LOGL_FATAL (   logger,
  message... 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isFatalEnabled()) { \
log.log(log4cxx::Level::getFatal(), LOG4CXX_LOCATION, message); \
} \
} while (false)

Log a fatal-level message using a varargs/printf style interface.

Parameters
loggerEither a logger name or a Log object.
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 569 of file Log.h.

◆ LOGL_INFO

#define LOGL_INFO (   logger,
  message... 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isInfoEnabled()) { \
log.log(log4cxx::Level::getInfo(), LOG4CXX_LOCATION, message); \
} \
} while (false)

Log a info-level message using a varargs/printf style interface.

Parameters
loggerEither a logger name or a Log object.
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 521 of file Log.h.

◆ LOGL_TRACE

#define LOGL_TRACE (   logger,
  message... 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (LOG4CXX_UNLIKELY(log.isTraceEnabled())) { \
log.log(log4cxx::Level::getTrace(), LOG4CXX_LOCATION, message);\
} \
} while (false)

Log a trace-level message using a varargs/printf style interface.

Parameters
loggerEither a logger name or a Log object.
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 489 of file Log.h.

◆ LOGL_WARN

#define LOGL_WARN (   logger,
  message... 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isWarnEnabled()) { \
log.log(log4cxx::Level::getWarn(), LOG4CXX_LOCATION, message); \
} \
} while (false)

Log a warn-level message using a varargs/printf style interface.

Parameters
loggerEither a logger name or a Log object.
messageAn sprintf-compatible format string followed by zero, one, or more comma-separated arguments.

Definition at line 537 of file Log.h.

◆ LOGLS_DEBUG

#define LOGLS_DEBUG (   logger,
  message 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (LOG4CXX_UNLIKELY(log.isDebugEnabled())) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getDebug(), message); \
} \
} while (false)

Log a debug-level message using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGLS_DEBUG(logger, "coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
loggerEither a logger name or a Log object.
messageMessage to be logged.

Definition at line 609 of file Log.h.

◆ LOGLS_ERROR

#define LOGLS_ERROR (   logger,
  message 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isErrorEnabled()) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getError(), message); \
} \
} while (false)

Log a error-level message using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGLS_ERROR(logger, "coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
loggerEither a logger name or a Log object.
messageMessage to be logged.

Definition at line 669 of file Log.h.

◆ LOGLS_FATAL

#define LOGLS_FATAL (   logger,
  message 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isFatalEnabled()) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getFatal(), message); \
} \
} while (false)

Log a fatal-level message using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGLS_FATAL(logger, "coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
loggerEither a logger name or a Log object.
messageMessage to be logged.

Definition at line 689 of file Log.h.

◆ LOGLS_INFO

#define LOGLS_INFO (   logger,
  message 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isInfoEnabled()) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getInfo(), message); \
} \
} while (false)

Log a info-level message using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGLS_INFO(logger, "coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
loggerEither a logger name or a Log object.
messageMessage to be logged.

Definition at line 629 of file Log.h.

◆ LOGLS_TRACE

#define LOGLS_TRACE (   logger,
  message 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (LOG4CXX_UNLIKELY(log.isTraceEnabled())) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getTrace(), message); \
} \
} while (false)

Log a trace-level message using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGLS_TRACE(logger, "coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
loggerEither a logger name or a Log object.
messageMessage to be logged.

Definition at line 589 of file Log.h.

◆ LOGLS_WARN

#define LOGLS_WARN (   logger,
  message 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isWarnEnabled()) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getWarn(), message); \
} \
} while (false)

Log a warn-level message using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGLS_WARN(logger, "coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
loggerEither a logger name or a Log object.
messageMessage to be logged.

Definition at line 649 of file Log.h.

◆ LOGS

#define LOGS (   logger,
  level,
  message 
)
Value:
do { \
lsst::log::Log log(lsst::log::Log::getLogger(logger)); \
if (log.isEnabledFor(level)) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::toLevel(level), message); \
} \
} while (false)

Log a message using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGS("logger", LOG_LVL_DEBUG, "coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
loggerEither a logger name or a Log object.
levelLogging level associated with message.
messageMessage to be logged.

Definition at line 359 of file Log.h.

◆ LOGS_DEBUG

#define LOGS_DEBUG (   message)
Value:
do { \
lsst::log::Log log; \
if (LOG4CXX_UNLIKELY(log.isDebugEnabled())) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getDebug(), message); \
} \
} while (false)

Log a debug-level message to the default logger using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGS_DEBUG("coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
messageMessage to be logged.

Definition at line 397 of file Log.h.

◆ LOGS_ERROR

#define LOGS_ERROR (   message)
Value:
do { \
lsst::log::Log log; \
if (log.isErrorEnabled()) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getError(), message); \
} \
} while (false)

Log a error-level message to the default logger using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGS_ERROR("coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
messageMessage to be logged.

Definition at line 454 of file Log.h.

◆ LOGS_FATAL

#define LOGS_FATAL (   message)
Value:
do { \
lsst::log::Log log; \
if (log.isFatalEnabled()) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getFatal(), message); \
} \
} while (false)

Log a fatal-level message to the default logger using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGS_FATAL("coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
messageMessage to be logged.

Definition at line 473 of file Log.h.

◆ LOGS_INFO

#define LOGS_INFO (   message)
Value:
do { \
lsst::log::Log log; \
if (log.isInfoEnabled()) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getInfo(), message); \
} \
} while (false)

Log a info-level message to the default logger using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGS_INFO("coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
messageMessage to be logged.

Definition at line 416 of file Log.h.

◆ LOGS_TRACE

#define LOGS_TRACE (   message)
Value:
do { \
lsst::log::Log log; \
if (LOG4CXX_UNLIKELY(log.isTraceEnabled())) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getTrace(), message); \
} \
} while (false)

Log a trace-level message to the default logger using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGS_TRACE("coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
messageMessage to be logged.

Definition at line 378 of file Log.h.

◆ LOGS_WARN

#define LOGS_WARN (   message)
Value:
do { \
lsst::log::Log log; \
if (log.isWarnEnabled()) { \
LOG_MESSAGE_VIA_STREAM_(log, log4cxx::Level::getWarn(), message); \
} \
} while (false)

Log a warning-level message to the default logger using an iostream-based interface.

Message is any expression which can appear on the right side of the stream insertion operator, e.g. LOGS_WARN("coordinates: x=" << x << " y=" << y);. Usual caveat regarding commas inside macro arguments applies to message argument.

Parameters
messageMessage to be logged.

Definition at line 435 of file Log.h.

lsst::afw.display.interface.logger
logger
Definition: interface.py:39
lsst::log::Log::getLogger
static Log getLogger(Log const &logger)
Definition: Log.h:760
lsst::base.packages.log
log
Definition: packages.py:38
lsstDebug.getInfo
getInfo
Definition: lsstDebug.py:87
std::ostringstream
STL class.
std::ostringstream::str
T str(T... args)