logging::LogHelper Class Reference

Your opinion will help to improve our service

Leave a feedback >

Table of Contents

• Detailed Description
• Public Member Functions
• Constructor & Destructor Documentation
• LogHelper() [1/2]
• LogHelper() [2/2]
• Member Function Documentation
• AsLvalue()
• Format()
• operator<<()

#include <userver/logging/log_helper.hpp>

Detailed Description

Stream-like tskv-formatted log message builder.

Users can add LogHelper& operator<<(LogHelper&, ) overloads to use a faster localeless logging, rather than outputting data through the ostream operator.

Definition at line 77 of file log_helper.hpp.

Public Member Functions
	LogHelper (LoggerRef logger, Level level, LogClass log_class=LogClass::kLog, const utils::impl::SourceLocation &location=utils::impl::SourceLocation::Current()) noexcept
	Constructs LogHelper with span logging.
	LogHelper (const LoggerPtr &logger, Level level, LogClass log_class=LogClass::kLog, const utils::impl::SourceLocation &location=utils::impl::SourceLocation::Current()) noexcept
	Constructs LogHelper with span logging.
	LogHelper (LogHelper &&)=delete
	LogHelper (const LogHelper &)=delete
LogHelper &	operator= (LogHelper &&)=delete
LogHelper &	operator= (const LogHelper &)=delete
LogHelper &	AsLvalue () noexcept
bool	IsLimitReached () const noexcept
template<typename T>
LogHelper &	operator<< (const T &value)
LogHelper &	operator<< (char value) noexcept
LogHelper &	operator<< (std::string_view value) noexcept
LogHelper &	operator<< (float value) noexcept
LogHelper &	operator<< (double value) noexcept
LogHelper &	operator<< (long double value) noexcept
LogHelper &	operator<< (unsigned long long value) noexcept
LogHelper &	operator<< (long long value) noexcept
LogHelper &	operator<< (bool value) noexcept
LogHelper &	operator<< (const std::exception &value) noexcept
LogHelper &	operator<< (const LogExtra &extra) noexcept
	Extends internal LogExtra.
LogHelper &	operator<< (LogExtra &&extra) noexcept
	Extends internal LogExtra.
LogHelper &	operator<< (Hex hex) noexcept
LogHelper &	operator<< (HexShort hex) noexcept
LogHelper &	operator<< (Quoted value) noexcept
LogHelper &	PutTag (std::string_view key, const LogExtra::Value &value) noexcept
LogHelper &	PutSwTag (std::string_view key, std::string_view value) noexcept
template<typename... Args>
LogHelper &	Format (fmt::format_string< Args... > fmt, Args &&... args) noexcept
	Formats a log message using the specified format string and arguments.

Constructor & Destructor Documentation

LogHelper() [1/2]

logging::LogHelper::LogHelper ( LoggerRef logger, Level level, LogClass log_class = LogClass::kLog, const utils::impl::SourceLocation & location = utils::impl::SourceLocation::Current() )

noexcept

Constructs LogHelper with span logging.

Parameters

logger	to log to
level	message log level
log_class	whether this LogHelper will be used to write a log record or a span
location	source location that will be written to logs

LogHelper() [2/2]

logging::LogHelper::LogHelper ( const LoggerPtr & logger, Level level, LogClass log_class = LogClass::kLog, const utils::impl::SourceLocation & location = utils::impl::SourceLocation::Current() )

noexcept

Constructs LogHelper with span logging.

Parameters

logger	to log to (logging to nullptr does not output messages)
level	message log level
log_class	whether this LogHelper will be used to write a log record or a span
location	source location that will be written to logs

Member Function Documentation

AsLvalue()

LogHelper & logging::LogHelper::AsLvalue ( )

inlinenoexcept

Definition at line 111 of file log_helper.hpp.

Format()

template<typename... Args>

LogHelper & logging::LogHelper::Format ( fmt::format_string< Args... > fmt, Args &&... args )

noexcept

Formats a log message using the specified format string and arguments.

Parameters

fmt	The format string as per fmtlib.
args	Arguments to be formatted into the log message.

Returns

A reference to the LogHelper object for chaining.

Definition at line 363 of file log_helper.hpp.

operator<<()

template<typename T>

LogHelper & logging::LogHelper::operator<< ( const T & value )

inline

Definition at line 124 of file log_helper.hpp.

---

The documentation for this class was generated from the following file:

• userver/logging/log_helper.hpp