lsst.log
16.0-1-gce273f5+14
|
LSST DM logging module built on log4cxx. More...
#include <functional>
#include <sstream>
#include <stdarg.h>
#include <string>
#include <vector>
#include <log4cxx/logger.h>
#include <boost/format.hpp>
Go to the source code of this file.
Classes | |
class | lsst::log::Log |
class | lsst::log::LogContext |
Macros | |
#define | LOG_CONFIG(filename) lsst::log::Log::configure(filename) |
#define | LOG_CONFIG_PROP(string) lsst::log::Log::configure_prop(string) |
#define | LOG_DEFAULT_NAME() lsst::log::Log::getDefaultLoggerName() |
#define | LOG_GET(logger) lsst::log::Log::getLogger(logger) |
#define | LOG_PUSHCTX(name) lsst::log::Log::pushContext(name) |
#define | LOG_POPCTX() lsst::log::Log::popContext() |
#define | LOG_MDC(key, value) lsst::log::Log::MDC(key, value) |
#define | LOG_MDC_REMOVE(key) lsst::log::Log::MDCRemove(key) |
#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 |
#define | LOG_CTX lsst::log::LogContext |
Functions | |
unsigned | lsst::log::lwpID () |
LSST DM logging module built on log4cxx.
#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()) |
Return whether the logging threshold of the default logger is less than or equal to DEBUG.
#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.
#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.
#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.
#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.
logger | Either a logger name or a Log object being queried. |
level | Logging threshold to check. |
#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.
#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.
#define LOG_CONFIG | ( | filename | ) | lsst::log::Log::configure(filename) |
Configures log4cxx and initializes logging module.
filename | Path to configuration file. |
#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_DEFAULT_NAME | ( | ) | lsst::log::Log::getDefaultLoggerName() |
Get the current default logger name. Returns empty string for root logger.
#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) |
Returns a Log object associated with logger.
logger | Either a logger name or a Log object. |
#define LOG_GET_LVL | ( | logger | ) | lsst::log::Log::getLogger(logger).getLevel() |
Retrieve the logging threshold for LOGGER.
logger | Either a logger name or a Log object with threshold to return. |
#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_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:
func | Any function object which takes no arguments and returns void. |
#define LOG_MDC_REMOVE | ( | key | ) | lsst::log::Log::MDCRemove(key) |
Remove the value associated with KEY within the MDC.
key | Key identifying value to remove. |
#define LOG_MESSAGE_VIA_STREAM_ | ( | logger, | |
level, | |||
message | |||
) |
#define LOG_POPCTX | ( | ) | lsst::log::Log::popContext() |
Pops the last pushed name off the global hierarchical default logger name.
#define LOG_PUSHCTX | ( | name | ) | lsst::log::Log::pushContext(name) |
Pushes name onto the global hierarchical default logger name. Note that we only allow simple non-dotted names to be used for context names, multi-level context name (e.g. "componen1.component2") will result in exception. Empty context names are disallowed as well, exception will be raised for empty name.
name | String to push onto logging context. |
std::invalid_argument | raised for empty name or when name contains dot. |
#define LOG_SET_LVL | ( | logger, | |
level | |||
) | lsst::log::Log::getLogger(logger).setLevel(level) |
Set the logging threshold for LOGGER to LEVEL.
logger | Logger with threshold to adjust. |
level | New logging threshold. |
#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. |
unsigned lsst::log::lwpID | ( | ) |
Function which returns LWP ID on platforms which support it.
On all other platforms a small incremental integer number (counting number of threads) is returned. This function can be used to produce more human-friendly thread ID for logging instead of regular t format.