Detailed Description

Logging macro and utilities.

Namespaces
namespace	stacktrace_cache
	Contains functions that cache stacktrace results.

Classes
class	DefaultLoggerGuard
	Atomically replaces the default logger. More...

class	DefaultLoggerLevelScope
	Allows to override global log level for the whole service within a scope. Primarily for use in tests. More...

struct	Hex
	Formats value in a hex mode with the fixed length representation. More...

struct	HexShort

class	JsonString

class	LogExtra
	Extra tskv fields storage. More...

class	LogHelper

struct	Quoted
	Formats a string as quoted, escaping the '\' and '"' symbols. More...

Typedefs
using	LoggerRef = impl::LoggerBase&

using	LoggerPtr = std::shared_ptr<impl::LoggerBase>

using	TextLoggerRef = impl::TextLogger&

using	TextLoggerPtr = std::shared_ptr<impl::TextLogger>

Enumerations
enum class	Level : std::uint8_t { kTrace = 0 , kDebug = 1 , kInfo = 2 , kWarning = 3 , kError = 4 , kCritical = 5 , kNone = 6 }
	Log levels. More...

enum class	LogClass { kLog , kTrace }

enum class	Format { kTskv , kLtsv , kRaw , kJson , kJsonYaDeploy }
	Text-based log formats. More...

Functions
Level	LevelFromString (std::string_view)
	Converts lowercase level name to a corresponding Level, throws std::runtime_error if no matching log level found.

std::string_view	ToString (Level level)
	Returns a string representation of logging level, e.g. "info".

std::string_view	ToUpperCaseString (Level level) noexcept
	Returns a string representation of logging level, e.g. "INFO".

std::optional< Level >	OptionalLevelFromString (const std::optional< std::string > &level_name)
	Returns std::nullopt if level_name is std::nullopt, otherwise behaves exactly like logging::LevelFromString.

LoggerRef	GetDefaultLogger () noexcept
	Returns the default logger previously set by SetDefaultLogger. If the logger was not set - returns a logger that does no logging.

void	SetDefaultLoggerLevel (Level)
	Sets new log level for the default logger.

Level	GetDefaultLoggerLevel () noexcept
	Returns log level for the default logger.

bool	ShouldLog (Level level) noexcept

void	SetLoggerLevel (LoggerRef, Level)
	Sets new log level for a logger.

bool	LoggerShouldLog (LoggerRef logger, Level level) noexcept

bool	LoggerShouldLog (const LoggerPtr &logger, Level level) noexcept

Level	GetLoggerLevel (LoggerRef logger) noexcept

void	LogFlush ()
	Forces flush of default logger message queue.

void	LogFlush (LoggerRef logger)
	Forces flush of `logger` message queue.

LogHelper &	operator<< (LogHelper &lh, std::error_code ec)

template<typename T>
LogHelper &	operator<< (LogHelper &lh, const std::atomic< T > &value)

template<typename T>
LogHelper &	operator<< (LogHelper &lh, const T *value) noexcept

template<typename T>
LogHelper &	operator<< (LogHelper &lh, T *value)

template<typename T>
LogHelper &	operator<< (LogHelper &lh, const std::optional< T > &value)

template<typename Fun, typename = std::enable_if_t<std::is_invocable_r_v<void, Fun, LogHelper&>>>
LogHelper &	operator<< (LogHelper &lh, Fun &&value)

template<class Result, class... Args>
LogHelper &	operator<< (LogHelper &lh, Result(*)(Args...))

LogHelper &	operator<< (LogHelper &lh, std::chrono::system_clock::time_point tp)

LogHelper &	operator<< (LogHelper &lh, std::chrono::seconds value)

LogHelper &	operator<< (LogHelper &lh, std::chrono::milliseconds value)

LogHelper &	operator<< (LogHelper &lh, std::chrono::microseconds value)

LogHelper &	operator<< (LogHelper &lh, std::chrono::nanoseconds value)

LogHelper &	operator<< (LogHelper &lh, std::chrono::minutes value)

LogHelper &	operator<< (LogHelper &lh, std::chrono::hours value)

void	WriteToStream (const JsonString &value, formats::json::StringBuilder &sw)

Format	FormatFromString (std::string_view format_str)
	Parse Format enum from string.

template<typename... Types>
LogHelper &	operator<< (LogHelper &lh, const std::tuple< Types... > &value)

TextLoggerRef	GetNullLogger () noexcept
	Returns a logger that drops all incoming messages.

TextLoggerPtr	MakeNullLogger ()
	Creates a logger that drops all incoming messages.

Level	Parse (const yaml_config::YamlConfig &value, formats::parse::To< Level >)

Level	Parse (const formats::json::Value &value, formats::parse::To< Level >)

LoggerPtr	MakeStderrLogger (const std::string &name, Format format, Level level=Level::kInfo)
	Creates synchronous stderr logger with default tskv pattern.

LoggerPtr	MakeStdoutLogger (const std::string &name, Format format, Level level=Level::kInfo)
	Creates synchronous stdout logger with default tskv pattern.

LoggerPtr	MakeFileLogger (const std::string &name, const std::string &path, Format format, Level level=Level::kInfo)
	Creates synchronous file logger with default tskv pattern.

Variables
constexpr auto	kLevelMax = static_cast<int>(Level::kNone)

const LogExtra	kEmptyLogExtra

Typedef Documentation

◆ LoggerPtr

using logging::LoggerPtr = std::shared_ptr<impl::LoggerBase>

Definition at line 20 of file fwd.hpp.

◆ LoggerRef

using logging::LoggerRef = impl::LoggerBase&

Definition at line 19 of file fwd.hpp.

◆ TextLoggerPtr

using logging::TextLoggerPtr = std::shared_ptr<impl::TextLogger>

Definition at line 22 of file fwd.hpp.

◆ TextLoggerRef

using logging::TextLoggerRef = impl::TextLogger&

Definition at line 21 of file fwd.hpp.

Enumeration Type Documentation

◆ Format

enum class logging::Format

strong

Text-based log formats.

For otlp logs, see Logging and Tracing

Definition at line 15 of file format.hpp.

◆ Level

enum class logging::Level : std::uint8_t

strong

Log levels.

Definition at line 16 of file level.hpp.

◆ LogClass

enum class logging::LogClass

strong

Definition at line 67 of file log_helper.hpp.

Function Documentation

◆ GetDefaultLogger()

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.

Note: While the coroutine engine is running, any reference to the default logger is guaranteed to be alive. No lifetime guarantees are given for the default logger reference outside the engine's lifetime. The rule of thumb there is not to keep this reference in any extended scope.

◆ GetNullLogger()

TextLoggerRef logging::GetNullLogger ( )

noexcept

Returns a logger that drops all incoming messages.

See also: components::Logging

◆ MakeFileLogger()

LoggerPtr logging::MakeFileLogger	(	const std::string &	name,
		const std::string &	path,
		Format	format,
		Level	level = Level::kInfo )

Creates synchronous file logger with default tskv pattern.

Parameters

name	logger name, for internal use, must be unique
path	target log file path
format	logs output format
level	minimum logs level to write to this logger, a.k.a. logger's log level

See also: components::Logging

◆ MakeNullLogger()

TextLoggerPtr logging::MakeNullLogger ( )

Creates a logger that drops all incoming messages.

Use GetNullLogger() is you need a reference to logger.

See also: components::Logging

◆ MakeStderrLogger()

LoggerPtr logging::MakeStderrLogger	(	const std::string &	name,
		Format	format,
		Level	level = Level::kInfo )

Creates synchronous stderr logger with default tskv pattern.

Parameters

name	logger name, for internal use, must be unique
format	logs output format
level	minimum logs level to write to this logger, a.k.a. logger's log level

See also: components::Logging

◆ MakeStdoutLogger()

LoggerPtr logging::MakeStdoutLogger	(	const std::string &	name,
		Format	format,
		Level	level = Level::kInfo )

Creates synchronous stdout logger with default tskv pattern.

Parameters

name	logger name, for internal use, must be unique
format	logs output format
level	minimum logs level to write to this logger, a.k.a. logger's log level

See also: components::Logging

◆ operator<<() [1/8]

template<typename T>

LogHelper & logging::operator<<	(	LogHelper &	lh,
		const std::atomic< T > &	value )

Definition at line 237 of file log_helper.hpp.

◆ operator<<() [2/8]

template<typename T>

LogHelper & logging::operator<<	(	LogHelper &	lh,
		const std::optional< T > &	value )

Definition at line 263 of file log_helper.hpp.

◆ operator<<() [3/8]

template<typename... Types>

LogHelper & logging::operator<<	(	LogHelper &	lh,
		const std::tuple< Types... > &	value )

Definition at line 15 of file log_helper_extras.hpp.

◆ operator<<() [4/8]

template<typename T>

LogHelper & logging::operator<<	(	LogHelper &	lh,
		const T *	value )

noexcept

Definition at line 242 of file log_helper.hpp.

◆ operator<<() [5/8]

template<typename Fun, typename = std::enable_if_t<std::is_invocable_r_v<void, Fun, LogHelper&>>>

LogHelper & logging::operator<<	(	LogHelper &	lh,
		Fun &&	value )

Definition at line 272 of file log_helper.hpp.

◆ operator<<() [6/8]

template<class Result, class... Args>

LogHelper & logging::operator<<	(	LogHelper &	lh,
		Result(*	)(Args...) )

Definition at line 278 of file log_helper.hpp.

◆ operator<<() [7/8]

LogHelper & logging::operator<<	(	LogHelper &	lh,
		std::error_code	ec )

inline

Definition at line 231 of file log_helper.hpp.

◆ operator<<() [8/8]

template<typename T>

LogHelper & logging::operator<<	(	LogHelper &	lh,
		T *	value )

Definition at line 254 of file log_helper.hpp.

◆ SetDefaultLoggerLevel()

void logging::SetDefaultLoggerLevel ( Level )

Sets new log level for the default logger.

Note: Prefer using logging::DefaultLoggerLevelScope if possible

◆ ShouldLog()

bool logging::ShouldLog ( Level level )

noexcept

Returns true if the provided log level is greater or equal to the current log level and to the tracing::Span (if any) local log level.

Variable Documentation

◆ kLevelMax

auto logging::kLevelMax = static_cast<int>(Level::kNone)

inlineconstexpr

Definition at line 26 of file level.hpp.

Detailed Description

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ LoggerPtr

◆ LoggerRef

◆ TextLoggerPtr

◆ TextLoggerRef

Enumeration Type Documentation

◆ Format

◆ Level

◆ LogClass

Function Documentation

◆ GetDefaultLogger()

◆ GetNullLogger()

◆ MakeFileLogger()

◆ MakeNullLogger()

◆ MakeStderrLogger()

◆ MakeStdoutLogger()

◆ operator<<() [1/8]

◆ operator<<() [2/8]

◆ operator<<() [3/8]

◆ operator<<() [4/8]

◆ operator<<() [5/8]

◆ operator<<() [6/8]

◆ operator<<() [7/8]

◆ operator<<() [8/8]

◆ SetDefaultLoggerLevel()

◆ ShouldLog()

Variable Documentation

◆ kLevelMax