Logging Macros¶
Compile-Time Log Level Filtering¶
To optimise performance by reducing branches in compiled code, you can enable compile-time filtering of log levels.
This is done by defining QUILL_COMPILE_ACTIVE_LOG_LEVEL as a compilation flag or before including LogMacros.h:
QUILL_COMPILE_ACTIVE_LOG_LEVEL_{DESIRED_LEVEL}
Where {DESIRED_LEVEL} can be one of the following: TRACE_L3, TRACE_L2, TRACE_L1, DEBUG, INFO, WARNING, ERROR, CRITICAL.
For example, to compile only with warnings and above, you would define:
#define QUILL_COMPILE_ACTIVE_LOG_LEVEL QUILL_COMPILE_ACTIVE_LOG_LEVEL_WARNING
#include "quill/LogMacros.h"
or
target_compile_definitions(${TARGET} PUBLIC -DQUILL_COMPILE_ACTIVE_LOG_LEVEL=QUILL_COMPILE_ACTIVE_LOG_LEVEL_WARNING)
Standard Logging Macros¶
Trace Level 3 (L3)
LOG_TRACE_L3(logger, fmt, ...)LOG_TRACE_L3_LIMIT(min_interval, logger, fmt, ...)LOG_TRACE_L3_LIMIT_EVERY_N(n_occurrences, logger, fmt, ...)LOG_TRACE_L3_TAGS(logger, tags, fmt, ...)
Trace Level 2 (L2)
LOG_TRACE_L2(logger, fmt, ...)LOG_TRACE_L2_LIMIT(min_interval, logger, fmt, ...)LOG_TRACE_L2_LIMIT_EVERY_N(n_occurrences, logger, fmt, ...)LOG_TRACE_L2_TAGS(logger, tags, fmt, ...)
Trace Level 1 (L1)
LOG_TRACE_L1(logger, fmt, ...)LOG_TRACE_L1_LIMIT(min_interval, logger, fmt, ...)LOG_TRACE_L1_LIMIT_EVERY_N(n_occurrences, logger, fmt, ...)LOG_TRACE_L1_TAGS(logger, tags, fmt, ...)
Debug
LOG_DEBUG(logger, fmt, ...)LOG_DEBUG_LIMIT(min_interval, logger, fmt, ...)LOG_DEBUG_LIMIT_EVERY_N(n_occurrences, logger, fmt, ...)LOG_DEBUG_TAGS(logger, tags, fmt, ...)
Info
LOG_INFO(logger, fmt, ...)LOG_INFO_LIMIT(min_interval, logger, fmt, ...)LOG_INFO_LIMIT_EVERY_N(n_occurrences, logger, fmt, ...)LOG_INFO_TAGS(logger, tags, fmt, ...)
Notice
LOG_NOTICE(logger, fmt, ...)LOG_NOTICE_LIMIT(min_interval, logger, fmt, ...)LOG_NOTICE_LIMIT_EVERY_N(n_occurrences, logger, fmt, ...)LOG_NOTICE_TAGS(logger, tags, fmt, ...)
Warning
LOG_WARNING(logger, fmt, ...)LOG_WARNING_LIMIT(min_interval, logger, fmt, ...)LOG_WARNING_LIMIT_EVERY_N(n_occurrences, logger, fmt, ...)LOG_WARNING_TAGS(logger, tags, fmt, ...)
Error
LOG_ERROR(logger, fmt, ...)LOG_ERROR_LIMIT(min_interval, logger, fmt, ...)LOG_ERROR_LIMIT_EVERY_N(n_occurrences, logger, fmt, ...)LOG_ERROR_TAGS(logger, tags, fmt, ...)
Critical
LOG_CRITICAL(logger, fmt, ...)LOG_CRITICAL_LIMIT(min_interval, logger, fmt, ...)LOG_CRITICAL_LIMIT_EVERY_N(n_occurrences, logger, fmt, ...)LOG_CRITICAL_TAGS(logger, tags, fmt, ...)
Backtrace
LOG_BACKTRACE(logger, fmt, ...)
Value-based Macros (LOGV)¶
The following enhanced macros simplify logging by automatically printing variable names and values without explicitly specifying each variable name or using {} placeholders in the format string. Each macro can handle up to 26 arguments. The format string is concatenated at compile time, there is no runtime overhead for using these macros.
Trace Level 3 (L3)
LOGV_TRACE_L3(logger, message, ...)LOGV_TRACE_L3_LIMIT(min_interval, logger, message, ...)LOGV_TRACE_L3_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGV_TRACE_L3_TAGS(logger, tags, message, ...)
Trace Level 2 (L2)
LOGV_TRACE_L2(logger, message, ...)LOGV_TRACE_L2_LIMIT(min_interval, logger, message, ...)LOGV_TRACE_L2_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGV_TRACE_L2_TAGS(logger, tags, message, ...)
Trace Level 1 (L1)
LOGV_TRACE_L1(logger, message, ...)LOGV_TRACE_L1_LIMIT(min_interval, logger, message, ...)LOGV_TRACE_L1_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGV_TRACE_L1_TAGS(logger, tags, message, ...)
Debug
LOGV_DEBUG(logger, message, ...)LOGV_DEBUG_LIMIT(min_interval, logger, message, ...)LOGV_DEBUG_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGV_DEBUG_TAGS(logger, tags, message, ...)
Info
LOGV_INFO(logger, message, ...)LOGV_INFO_LIMIT(min_interval, logger, message, ...)LOGV_INFO_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGV_INFO_TAGS(logger, tags, message, ...)
Notice
LOGV_NOTICE(logger, message, ...)LOGV_NOTICE_LIMIT(min_interval, logger, message, ...)LOGV_NOTICE_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGV_NOTICE_TAGS(logger, tags, message, ...)
Warning
LOGV_WARNING(logger, message, ...)LOGV_WARNING_LIMIT(min_interval, logger, message, ...)LOGV_WARNING_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGV_WARNING_TAGS(logger, tags, message, ...)
Error
LOGV_ERROR(logger, message, ...)LOGV_ERROR_LIMIT(min_interval, logger, message, ...)LOGV_ERROR_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGV_ERROR_TAGS(logger, tags, message, ...)
Critical
LOGV_CRITICAL(logger, message, ...)LOGV_CRITICAL_LIMIT(min_interval, logger, message, ...)LOGV_CRITICAL_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGV_CRITICAL_TAGS(logger, tags, message, ...)
Backtrace
LOGV_BACKTRACE(logger, message, ...)
JSON Logging Macros (LOGJ)¶
The following macros simplify JSON logging by automatically embedding the name of each passed variable as a named argument in the format string. Each macro can handle up to 26 arguments. The format string is concatenated at compile time, there is no runtime overhead for using these macros.
Trace Level 3 (L3)
LOGJ_TRACE_L3(logger, message, ...)LOGJ_TRACE_L3_LIMIT(min_interval, logger, message, ...)LOGJ_TRACE_L3_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGJ_TRACE_L3_TAGS(logger, tags, message, ...)
Trace Level 2 (L2)
LOGJ_TRACE_L2(logger, message, ...)LOGJ_TRACE_L2_LIMIT(min_interval, logger, message, ...)LOGJ_TRACE_L2_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGJ_TRACE_L2_TAGS(logger, tags, message, ...)
Trace Level 1 (L1)
LOGJ_TRACE_L1(logger, message, ...)LOGJ_TRACE_L1_LIMIT(min_interval, logger, message, ...)LOGJ_TRACE_L1_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGJ_TRACE_L1_TAGS(logger, tags, message, ...)
Debug
LOGJ_DEBUG(logger, message, ...)LOGJ_DEBUG_LIMIT(min_interval, logger, message, ...)LOGJ_DEBUG_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGJ_DEBUG_TAGS(logger, tags, message, ...)
Info
LOGJ_INFO(logger, message, ...)LOGJ_INFO_LIMIT(min_interval, logger, message, ...)LOGJ_INFO_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGJ_INFO_TAGS(logger, tags, message, ...)
Notice
LOGJ_NOTICE(logger, message, ...)LOGJ_NOTICE_LIMIT(min_interval, logger, message, ...)LOGJ_NOTICE_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGJ_NOTICE_TAGS(logger, tags, message, ...)
Warning
LOGJ_WARNING(logger, message, ...)LOGJ_WARNING_LIMIT(min_interval, logger, message, ...)LOGJ_WARNING_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGJ_WARNING_TAGS(logger, tags, message, ...)
Error
LOGJ_ERROR(logger, message, ...)LOGJ_ERROR_LIMIT(min_interval, logger, message, ...)LOGJ_ERROR_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGJ_ERROR_TAGS(logger, tags, message, ...)
Critical
LOGJ_CRITICAL(logger, message, ...)LOGJ_CRITICAL_LIMIT(min_interval, logger, message, ...)LOGJ_CRITICAL_LIMIT_EVERY_N(n_occurrences, logger, message, ...)LOGJ_CRITICAL_TAGS(logger, tags, message, ...)
Backtrace
LOGJ_BACKTRACE(logger, message, ...)
Dynamic Logging Macros¶
Dynamic logging macros provide runtime log level flexibility with a small overhead. Prefer using the compile-time log level macros for zero-cost logging.
LOG_DYNAMIC(logger, log_level, fmt, ...)LOGV_DYNAMIC(logger, log_level, message, ...)LOGJ_DYNAMIC(logger, log_level, message, ...)