log.hpp File Reference

Detailed Description

Logging helpers.

Definition in file log.hpp.

Go to the source code of this file.

#include <chrono>
#include <userver/compiler/select.hpp>
#include <userver/logging/fwd.hpp>
#include <userver/logging/level.hpp>
#include <userver/logging/log_filepath.hpp>
#include <userver/logging/log_helper.hpp>

This graph shows which files directly or indirectly include this file:

Classes
class	logging::DefaultLoggerGuard
	Atomically replaces the default logger. More...
class	logging::DefaultLoggerLevelScope
	Allows to override global log level for the whole service within a scope. Primarily for use in tests. More...

Namespaces
namespace	logging
	Logging macro and utilities.

Macros
#define	LOG_TO(logger, lvl, ...)
	If lvl matches the verbosity then builds a stream and evaluates a message for the specified logger.
#define	LOG(lvl, ...)
	If lvl matches the verbosity then builds a stream and evaluates a message for the default logger.
#define	LOG_TRACE(...)   USERVER_IMPL_LOGS_TRACE_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kTrace, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kTrace.
#define	LOG_DEBUG(...)   USERVER_IMPL_LOGS_DEBUG_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kDebug, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kDebug.
#define	LOG_INFO(...)   USERVER_IMPL_LOGS_INFO_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kInfo, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kInfo.
#define	LOG_WARNING(...)   USERVER_IMPL_LOGS_WARNING_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kWarning, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kWarning.
#define	LOG_ERROR(...)   USERVER_IMPL_LOGS_ERROR_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kError, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kError.
#define	LOG_CRITICAL(...)   LOG(USERVER_NAMESPACE::logging::Level::kCritical, __VA_ARGS__)
	Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kCritical.
#define	LOG_TRACE_TO(logger, ...)    USERVER_IMPL_LOGS_TRACE_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kTrace, __VA_ARGS__))
	Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kTrace.
#define	LOG_DEBUG_TO(logger, ...)    USERVER_IMPL_LOGS_DEBUG_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kDebug, __VA_ARGS__))
	Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kDebug.
#define	LOG_INFO_TO(logger, ...)    USERVER_IMPL_LOGS_INFO_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kInfo, __VA_ARGS__))
	Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kInfo.
#define	LOG_WARNING_TO(logger, ...)    USERVER_IMPL_LOGS_WARNING_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kWarning, __VA_ARGS__))
	Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kWarning.
#define	LOG_ERROR_TO(logger, ...)    USERVER_IMPL_LOGS_ERROR_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kError, __VA_ARGS__))
	Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kError.
#define	LOG_CRITICAL_TO(logger, ...)   LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kCritical, __VA_ARGS__)
	Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kCritical.
#define	LOG_LIMITED_TO(logger, lvl, ...)
	If lvl matches the verbosity then builds a stream and evaluates a message for the logger. Ignores log messages that occur too often.
#define	LOG_LIMITED(lvl, ...)   LOG_LIMITED_TO(USERVER_NAMESPACE::logging::GetDefaultLogger(), (lvl), __VA_ARGS__)
	If lvl matches the verbosity then builds a stream and evaluates a message for the default logger. Ignores log messages that occur too often.
#define	LOG_LIMITED_TRACE(...)    USERVER_IMPL_LOGS_TRACE_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kTrace, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kTrace.
#define	LOG_LIMITED_DEBUG(...)    USERVER_IMPL_LOGS_DEBUG_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kDebug, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kDebug.
#define	LOG_LIMITED_INFO(...)    USERVER_IMPL_LOGS_INFO_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kInfo, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kInfo.
#define	LOG_LIMITED_WARNING(...)    USERVER_IMPL_LOGS_WARNING_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kWarning, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kWarning.
#define	LOG_LIMITED_ERROR(...)    USERVER_IMPL_LOGS_ERROR_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kError, __VA_ARGS__))
	Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kError.
#define	LOG_LIMITED_CRITICAL(...)   LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kCritical, __VA_ARGS__)
	Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kCritical.
#define	LOG_LIMITED_TRACE_TO(logger, ...)    USERVER_IMPL_LOGS_TRACE_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kTrace, __VA_ARGS__))
	Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kTrace.
#define	LOG_LIMITED_DEBUG_TO(logger, ...)    USERVER_IMPL_LOGS_DEBUG_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kDebug, __VA_ARGS__))
	Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kDebug.
#define	LOG_LIMITED_INFO_TO(logger, ...)    USERVER_IMPL_LOGS_INFO_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kInfo, __VA_ARGS__))
	Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kInfo.
#define	LOG_LIMITED_WARNING_TO(logger, ...)    USERVER_IMPL_LOGS_WARNING_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kWarning, __VA_ARGS__))
	Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kWarning.
#define	LOG_LIMITED_ERROR_TO(logger, ...)    USERVER_IMPL_LOGS_ERROR_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kError, __VA_ARGS__))
	Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kError.
#define	LOG_LIMITED_CRITICAL_TO(logger, ...)    LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kCritical, __VA_ARGS__)
	Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kCritical.

Functions
LoggerRef	logging::GetDefaultLogger () noexcept
	Returns the default logger previously set by SetDefaultLogger. If the logger was not set - returns a logger that does no logging.
void	logging::SetDefaultLoggerLevel (Level)
	Sets new log level for the default logger.
Level	logging::GetDefaultLoggerLevel () noexcept
	Returns log level for the default logger.
bool	logging::ShouldLog (Level level) noexcept
void	logging::SetLoggerLevel (LoggerRef, Level)
	Sets new log level for a logger.
bool	logging::LoggerShouldLog (LoggerRef logger, Level level) noexcept
bool	logging::LoggerShouldLog (const LoggerPtr &logger, Level level) noexcept
Level	logging::GetLoggerLevel (LoggerRef logger) noexcept
void	logging::LogFlush ()
	Forces flush of default logger message queue.
void	logging::LogFlush (LoggerRef logger)
	Forces flush of logger message queue.

Macro Definition Documentation

LOG

#define LOG	(		lvl,
			...
	)

If lvl matches the verbosity then builds a stream and evaluates a message for the default logger.

Definition at line 257 of file log.hpp.

LOG_CRITICAL

#define LOG_CRITICAL

(

...

)

LOG(USERVER_NAMESPACE::logging::Level::kCritical, __VA_ARGS__)

Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kCritical.

Definition at line 287 of file log.hpp.

LOG_CRITICAL_TO

#define LOG_CRITICAL_TO	(		logger,
			...
	)		LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kCritical, __VA_ARGS__)

Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kCritical.

Definition at line 324 of file log.hpp.

LOG_DEBUG

#define LOG_DEBUG

(

...

)

USERVER_IMPL_LOGS_DEBUG_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kDebug, __VA_ARGS__))

Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kDebug.

Examples

postgresql/functional_tests/basic_chaos/postgres_service.cpp, samples/config_service/main.cpp, samples/grpc_service/src/greeter_client.cpp, samples/ydb_service/components/federated_topic_reader.cpp, and samples/ydb_service/components/topic_reader.cpp.

Definition at line 267 of file log.hpp.

LOG_DEBUG_TO

#define LOG_DEBUG_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_DEBUG_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kDebug, __VA_ARGS__))

Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kDebug.

Definition at line 300 of file log.hpp.

LOG_ERROR

#define LOG_ERROR

(

...

)

USERVER_IMPL_LOGS_ERROR_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kError, __VA_ARGS__))

Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kError.

Examples

samples/config_service/main.cpp, samples/grpc_middleware_service/src/middlewares/server/auth.cpp, samples/grpc_middleware_service/src/middlewares/server/meta_filter.cpp, samples/ydb_service/components/federated_topic_reader.cpp, and samples/ydb_service/components/topic_reader.cpp.

Definition at line 282 of file log.hpp.

LOG_ERROR_TO

#define LOG_ERROR_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_ERROR_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kError, __VA_ARGS__))

Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kError.

Definition at line 318 of file log.hpp.

LOG_INFO

#define LOG_INFO

(

...

)

USERVER_IMPL_LOGS_INFO_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kInfo, __VA_ARGS__))

Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kInfo.

Examples

samples/tcp_full_duplex_service/main.cpp, samples/testsuite-support/src/logcapture.cpp, samples/ydb_service/components/federated_topic_reader.cpp, and samples/ydb_service/components/topic_reader.cpp.

Definition at line 272 of file log.hpp.

LOG_INFO_TO

#define LOG_INFO_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_INFO_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kInfo, __VA_ARGS__))

Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kInfo.

Definition at line 306 of file log.hpp.

LOG_LIMITED

#define LOG_LIMITED	(		lvl,
			...
	)		LOG_LIMITED_TO(USERVER_NAMESPACE::logging::GetDefaultLogger(), (lvl), __VA_ARGS__)

If lvl matches the verbosity then builds a stream and evaluates a message for the default logger. Ignores log messages that occur too often.

Definition at line 349 of file log.hpp.

LOG_LIMITED_CRITICAL

#define LOG_LIMITED_CRITICAL

(

...

)

LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kCritical, __VA_ARGS__)

Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kCritical.

Definition at line 390 of file log.hpp.

LOG_LIMITED_CRITICAL_TO

#define LOG_LIMITED_CRITICAL_TO	(		logger,
			...
	)		LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kCritical, __VA_ARGS__)

Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kCritical.

Definition at line 433 of file log.hpp.

LOG_LIMITED_DEBUG

#define LOG_LIMITED_DEBUG

(

...

)

USERVER_IMPL_LOGS_DEBUG_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kDebug, __VA_ARGS__))

Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kDebug.

Definition at line 362 of file log.hpp.

LOG_LIMITED_DEBUG_TO

#define LOG_LIMITED_DEBUG_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_DEBUG_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kDebug, __VA_ARGS__))

Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kDebug.

Definition at line 405 of file log.hpp.

LOG_LIMITED_ERROR

#define LOG_LIMITED_ERROR

(

...

)

USERVER_IMPL_LOGS_ERROR_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kError, __VA_ARGS__))

Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kError.

Definition at line 383 of file log.hpp.

LOG_LIMITED_ERROR_TO

#define LOG_LIMITED_ERROR_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_ERROR_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kError, __VA_ARGS__))

Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kError.

Definition at line 426 of file log.hpp.

LOG_LIMITED_INFO

#define LOG_LIMITED_INFO

(

...

)

USERVER_IMPL_LOGS_INFO_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kInfo, __VA_ARGS__))

Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kInfo.

Definition at line 369 of file log.hpp.

LOG_LIMITED_INFO_TO

#define LOG_LIMITED_INFO_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_INFO_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kInfo, __VA_ARGS__))

Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kInfo.

Definition at line 412 of file log.hpp.

LOG_LIMITED_TO

#define LOG_LIMITED_TO	(		logger,
			lvl,
			...
	)

If lvl matches the verbosity then builds a stream and evaluates a message for the logger. Ignores log messages that occur too often.

Definition at line 335 of file log.hpp.

LOG_LIMITED_TRACE

#define LOG_LIMITED_TRACE

(

...

)

USERVER_IMPL_LOGS_TRACE_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kTrace, __VA_ARGS__))

Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kTrace.

Definition at line 355 of file log.hpp.

LOG_LIMITED_TRACE_TO

#define LOG_LIMITED_TRACE_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_TRACE_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kTrace, __VA_ARGS__))

Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kTrace.

Definition at line 398 of file log.hpp.

LOG_LIMITED_WARNING

#define LOG_LIMITED_WARNING

(

...

)

USERVER_IMPL_LOGS_WARNING_ERASER(LOG_LIMITED(USERVER_NAMESPACE::logging::Level::kWarning, __VA_ARGS__))

Evaluates a message and logs it to the default logger if the log message does not occur too often and default logger level is below or equal to logging::Level::kWarning.

Definition at line 376 of file log.hpp.

LOG_LIMITED_WARNING_TO

#define LOG_LIMITED_WARNING_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_WARNING_ERASER(LOG_LIMITED_TO(logger, USERVER_NAMESPACE::logging::Level::kWarning, __VA_ARGS__))

Evaluates a message and logs it to the logger if the log message does not occur too often and logger level is below or equal to logging::Level::kWarning.

Definition at line 419 of file log.hpp.

LOG_TO

#define LOG_TO	(		logger,
			lvl,
			...
	)

If lvl matches the verbosity then builds a stream and evaluates a message for the specified logger.

Definition at line 245 of file log.hpp.

LOG_TRACE

#define LOG_TRACE

(

...

)

USERVER_IMPL_LOGS_TRACE_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kTrace, __VA_ARGS__))

Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kTrace.

Definition at line 262 of file log.hpp.

LOG_TRACE_TO

#define LOG_TRACE_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_TRACE_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kTrace, __VA_ARGS__))

Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kTrace.

Definition at line 294 of file log.hpp.

LOG_WARNING

#define LOG_WARNING

(

...

)

USERVER_IMPL_LOGS_WARNING_ERASER(LOG(USERVER_NAMESPACE::logging::Level::kWarning, __VA_ARGS__))

Evaluates a message and logs it to the default logger if its level is below or equal to logging::Level::kWarning.

Examples

grpc-generic-proxy/src/proxy_service.cpp, samples/ydb_service/components/federated_topic_reader.cpp, and samples/ydb_service/components/topic_reader.cpp.

Definition at line 277 of file log.hpp.

LOG_WARNING_TO

#define LOG_WARNING_TO	(		logger,
			...
	)		USERVER_IMPL_LOGS_WARNING_ERASER(LOG_TO(logger, USERVER_NAMESPACE::logging::Level::kWarning, __VA_ARGS__))

Evaluates a message and logs it to the logger if its level is below or equal to logging::Level::kWarning.

Definition at line 312 of file log.hpp.