LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
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) |
Configures log4cxx and initializes logging module. More... | |
#define | LOG_CONFIG_PROP(string) lsst::log::Log::configure_prop(string) |
Configures log4cxx from a string containing list of properties. More... | |
#define | LOG_GET(logger) lsst::log::Log::getLogger(logger) |
Returns a Log object associated with logger. More... | |
#define | LOG_GET_CHILD(logger, suffix) lsst::log::Log::getLogger(logger).getChild(suffix) |
Returns a Log object associated with descendant of a logger. More... | |
#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. More... | |
#define | LOG_MDC_REMOVE(key) lsst::log::Log::MDCRemove(key) |
Remove the value associated with KEY within the MDC. More... | |
#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); |
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. More... | |
#define | LOG_MDC_INIT(func) lsst::log::Log::MDCRegisterInit(std::function<void()>(func)) |
Register function for initialization of MDC. More... | |
#define | LOG_SET_LVL(logger, level) lsst::log::Log::getLogger(logger).setLevel(level) |
Set the logging threshold for LOGGER to LEVEL. More... | |
#define | LOG_GET_LVL(logger) lsst::log::Log::getLogger(logger).getLevel() |
Retrieve the logging threshold for LOGGER. More... | |
#define | LOG_GETEFF_LVL(logger) lsst::log::Log::getLogger(logger).getEffectiveLevel() |
Retrieve the effective logging threshold for LOGGER. More... | |
#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. More... | |
#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. More... | |
#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. More... | |
#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. More... | |
#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. More... | |
#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. More... | |
#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. More... | |
#define | LOG(logger, level, message...) |
Log a message using a varargs/printf style interface. More... | |
#define | LOG_TRACE(message...) |
Log a trace-level message to the default logger using a varargs/printf style interface. More... | |
#define | LOG_DEBUG(message...) |
Log a debug-level message to the default logger using a varargs/printf style interface. More... | |
#define | LOG_INFO(message...) |
Log a info-level message to the default logger using a varargs/printf style interface. More... | |
#define | LOG_WARN(message...) |
Log a warn-level message to the default logger using a varargs/printf style interface. More... | |
#define | LOG_ERROR(message...) |
Log a error-level message to the default logger using a varargs/printf style interface. More... | |
#define | LOG_FATAL(message...) |
Log a fatal-level message to the default logger using a varargs/printf style interface. More... | |
#define | LOG_MESSAGE_VIA_STREAM_(logger, level, message) |
#define | LOGS(logger, level, message) |
Log a message using an iostream-based interface. More... | |
#define | LOGS_TRACE(message) |
Log a trace-level message to the default logger using an iostream-based interface. More... | |
#define | LOGS_DEBUG(message) |
Log a debug-level message to the default logger using an iostream-based interface. More... | |
#define | LOGS_INFO(message) |
Log a info-level message to the default logger using an iostream-based interface. More... | |
#define | LOGS_WARN(message) |
Log a warning-level message to the default logger using an iostream-based interface. More... | |
#define | LOGS_ERROR(message) |
Log a error-level message to the default logger using an iostream-based interface. More... | |
#define | LOGS_FATAL(message) |
Log a fatal-level message to the default logger using an iostream-based interface. More... | |
#define | LOGL_TRACE(logger, message...) |
Log a trace-level message using a varargs/printf style interface. More... | |
#define | LOGL_DEBUG(logger, message...) |
Log a debug-level message using a varargs/printf style interface. More... | |
#define | LOGL_INFO(logger, message...) |
Log a info-level message using a varargs/printf style interface. More... | |
#define | LOGL_WARN(logger, message...) |
Log a warn-level message using a varargs/printf style interface. More... | |
#define | LOGL_ERROR(logger, message...) |
Log a error-level message using a varargs/printf style interface. More... | |
#define | LOGL_FATAL(logger, message...) |
Log a fatal-level message using a varargs/printf style interface. More... | |
#define | LOGLS_TRACE(logger, message) |
Log a trace-level message using an iostream-based interface. More... | |
#define | LOGLS_DEBUG(logger, message) |
Log a debug-level message using an iostream-based interface. More... | |
#define | LOGLS_INFO(logger, message) |
Log a info-level message using an iostream-based interface. More... | |
#define | LOGLS_WARN(logger, message) |
Log a warn-level message using an iostream-based interface. More... | |
#define | LOGLS_ERROR(logger, message) |
Log a error-level message using an iostream-based interface. More... | |
#define | LOGLS_FATAL(logger, message) |
Log a fatal-level message using an iostream-based interface. More... | |
#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... | |
LSST DM logging module built on log4cxx.
Definition in file Log.h.
#define LOG | ( | logger, | |
level, | |||
message... | |||
) |
Log a message using a varargs/printf style interface.
logger | Either a logger name or a Log object. |
level | Logging level associated with message. |
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOG_CHECK_DEBUG | ( | ) | LOG4CXX_UNLIKELY(lsst::log::Log::getDefaultLogger().isDebugEnabled()) |
#define LOG_CHECK_ERROR | ( | ) | lsst::log::Log::getDefaultLogger().isErrorEnabled() |
#define LOG_CHECK_FATAL | ( | ) | lsst::log::Log::getDefaultLogger().isFatalEnabled() |
#define LOG_CHECK_INFO | ( | ) | lsst::log::Log::getDefaultLogger().isInfoEnabled() |
#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_WARN | ( | ) | lsst::log::Log::getDefaultLogger().isWarnEnabled() |
#define LOG_CONFIG | ( | filename | ) | lsst::log::Log::configure(filename) |
#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.
string | List of properties (lines separated by new line character) |
#define LOG_DEBUG | ( | message... | ) |
Log a debug-level message to the default logger using a varargs/printf style interface.
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOG_ERROR | ( | message... | ) |
Log a error-level message to the default logger using a varargs/printf style interface.
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOG_FATAL | ( | message... | ) |
Log a fatal-level message to the default logger using a varargs/printf style interface.
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOG_GET | ( | logger | ) | lsst::log::Log::getLogger(logger) |
#define LOG_GET_CHILD | ( | logger, | |
suffix | |||
) | lsst::log::Log::getLogger(logger).getChild(suffix) |
#define LOG_GET_LVL | ( | logger | ) | lsst::log::Log::getLogger(logger).getLevel() |
#define LOG_GETEFF_LVL | ( | logger | ) | lsst::log::Log::getLogger(logger).getEffectiveLevel() |
#define LOG_INFO | ( | message... | ) |
Log a info-level message to the default logger using a varargs/printf style interface.
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOG_LOGGER lsst::log::Log |
#define LOG_LVL_DEBUG static_cast<int>(log4cxx::Level::DEBUG_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_LVL_INFO static_cast<int>(log4cxx::Level::INFO_INT) |
#define LOG_LVL_TRACE static_cast<int>(log4cxx::Level::TRACE_INT) |
#define LOG_LVL_WARN static_cast<int>(log4cxx::Level::WARN_INT) |
#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}
.
key | Unique key. |
value | String value. |
#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
func | Any function object which takes no arguments and returns void. |
#define LOG_MDC_REMOVE | ( | key | ) | lsst::log::Log::MDCRemove(key) |
#define LOG_MDC_SCOPE | ( | key, | |
value | |||
) | lsst::log::LogMDCScope LOG_CONCAT_IMPL2(_log_mdc_scope_, __COUNTER__)(key, value); |
#define LOG_MESSAGE_VIA_STREAM_ | ( | logger, | |
level, | |||
message | |||
) |
#define LOG_SET_LVL | ( | logger, | |
level | |||
) | lsst::log::Log::getLogger(logger).setLevel(level) |
#define LOG_TRACE | ( | message... | ) |
Log a trace-level message to the default logger using a varargs/printf style interface.
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOG_WARN | ( | message... | ) |
Log a warn-level message to the default logger using a varargs/printf style interface.
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOGL_DEBUG | ( | logger, | |
message... | |||
) |
Log a debug-level message using a varargs/printf style interface.
logger | Either a logger name or a Log object. |
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOGL_ERROR | ( | logger, | |
message... | |||
) |
Log a error-level message using a varargs/printf style interface.
logger | Either a logger name or a Log object. |
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOGL_FATAL | ( | logger, | |
message... | |||
) |
Log a fatal-level message using a varargs/printf style interface.
logger | Either a logger name or a Log object. |
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOGL_INFO | ( | logger, | |
message... | |||
) |
Log a info-level message using a varargs/printf style interface.
logger | Either a logger name or a Log object. |
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOGL_TRACE | ( | logger, | |
message... | |||
) |
Log a trace-level message using a varargs/printf style interface.
logger | Either a logger name or a Log object. |
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOGL_WARN | ( | logger, | |
message... | |||
) |
Log a warn-level message using a varargs/printf style interface.
logger | Either a logger name or a Log object. |
message | An sprintf-compatible format string followed by zero, one, or more comma-separated arguments. |
#define LOGLS_DEBUG | ( | logger, | |
message | |||
) |
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.
logger | Either a logger name or a Log object. |
message | Message to be logged. |
#define LOGLS_ERROR | ( | logger, | |
message | |||
) |
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.
logger | Either a logger name or a Log object. |
message | Message to be logged. |
#define LOGLS_FATAL | ( | logger, | |
message | |||
) |
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.
logger | Either a logger name or a Log object. |
message | Message to be logged. |
#define LOGLS_INFO | ( | logger, | |
message | |||
) |
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.
logger | Either a logger name or a Log object. |
message | Message to be logged. |
#define LOGLS_TRACE | ( | logger, | |
message | |||
) |
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.
logger | Either a logger name or a Log object. |
message | Message to be logged. |
#define LOGLS_WARN | ( | logger, | |
message | |||
) |
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.
logger | Either a logger name or a Log object. |
message | Message to be logged. |
#define LOGS | ( | logger, | |
level, | |||
message | |||
) |
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.
logger | Either a logger name or a Log object. |
level | Logging level associated with message. |
message | Message to be logged. |
#define LOGS_DEBUG | ( | message | ) |
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.
message | Message to be logged. |
#define LOGS_ERROR | ( | message | ) |
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.
message | Message to be logged. |
#define LOGS_FATAL | ( | message | ) |
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.
message | Message to be logged. |
#define LOGS_INFO | ( | message | ) |
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.
message | Message to be logged. |
#define LOGS_TRACE | ( | message | ) |
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.
message | Message to be logged. |
#define LOGS_WARN | ( | message | ) |
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.
message | Message to be logged. |