13#include <system_error>
18#include <userver/formats/common/meta.hpp>
19#include <userver/logging/fwd.hpp>
20#include <userver/logging/level.hpp>
21#include <userver/logging/log_extra.hpp>
22#include <userver/utils/impl/source_location.hpp>
23#include <userver/utils/meta.hpp>
25USERVER_NAMESPACE_BEGIN
38 template <
typename Unsigned,
typename = std::enable_if_t<std::is_unsigned_v<Unsigned>>>
39 explicit constexpr HexBase(Unsigned value)
noexcept : value(value) {
40 static_assert(
sizeof(Unsigned) <=
sizeof(value));
44 explicit HexBase(T* pointer)
noexcept : HexBase(
reinterpret_cast<std::uintptr_t>(pointer)) {
45 static_assert(
sizeof(std::uintptr_t) <=
sizeof(value));
52struct Hex
final : impl::HexBase {
53 using impl::HexBase::HexBase;
52struct Hex
final : impl::HexBase {
…};
58struct HexShort
final : impl::HexBase {
59 using impl::HexBase::HexBase;
58struct HexShort
final : impl::HexBase {
…};
64 std::string_view string;
63struct Quoted
final {
…};
77class LogHelper
final {
87 LogClass log_class = LogClass::kLog,
88 const utils::impl::SourceLocation& location =
utils::impl::SourceLocation::Current()
97 const LoggerPtr& logger,
99 LogClass log_class = LogClass::kLog,
100 const utils::impl::SourceLocation& location =
utils::impl::SourceLocation::Current()
105 LogHelper(LogHelper&&) =
delete;
106 LogHelper(
const LogHelper&) =
delete;
107 LogHelper& operator=(LogHelper&&) =
delete;
108 LogHelper& operator=(
const LogHelper&) =
delete;
111 LogHelper& AsLvalue()
noexcept {
return *
this; }
114 LogHelper& AsLvalue(std::string_view msg)
noexcept {
121 template <
typename... Args>
122 LogHelper& AsLvalue(fmt::format_string<Args...> fmt, Args&&... args)
noexcept {
123 VFormat(fmt::string_view(fmt), fmt::make_format_args(args...));
128 bool IsLimitReached()
const noexcept;
130 template <
typename T>
131 LogHelper& operator<<(
const T& value) {
132 if constexpr (std::is_constructible_v<std::string_view, T>) {
134 *
this << std::string_view{value};
135 }
else if constexpr (std::is_signed_v<T>) {
136 using LongLong =
long long;
137 *
this << LongLong{value};
138 }
else if constexpr (std::is_unsigned_v<T>) {
139 using UnsignedLongLong =
unsigned long long;
140 *
this << UnsignedLongLong{value};
141 }
else if constexpr (std::is_base_of_v<std::exception, T>) {
142 *
this <<
static_cast<
const std::exception&>(value);
143 }
else if constexpr (meta::kIsOstreamWritable<T>) {
147 }
else if constexpr (meta::kIsRange<T> && !
formats::
common::kIsFormatValue<T>) {
153 "Please implement logging for your type: "
154 "logging::LogHelper& operator<<(logging::LogHelper& lh, const T& value)"
161 LogHelper& operator<<(
char value)
noexcept;
162 LogHelper& operator<<(std::string_view value)
noexcept;
163 LogHelper& operator<<(
float value)
noexcept;
164 LogHelper& operator<<(
double value)
noexcept;
165 LogHelper& operator<<(
long double value)
noexcept;
166 LogHelper& operator<<(
unsigned long long value)
noexcept;
167 LogHelper& operator<<(
long long value)
noexcept;
168 LogHelper& operator<<(
bool value)
noexcept;
169 LogHelper& operator<<(
const std::exception& value)
noexcept;
172 LogHelper& operator<<(
const LogExtra& extra)
noexcept;
175 LogHelper& operator<<(LogExtra&& extra)
noexcept;
177 LogHelper& operator<<(Hex hex)
noexcept;
179 LogHelper& operator<<(HexShort hex)
noexcept;
181 LogHelper& operator<<(Quoted value)
noexcept;
183 LogHelper& PutTag(std::string_view key,
const LogExtra::Value& value)
noexcept;
184 LogHelper& PutSwTag(std::string_view key, std::string_view value)
noexcept;
186 template <
typename... Args>
187 LogHelper& Format(fmt::format_string<Args...> fmt, Args&&... args)
noexcept;
191 operator impl::Noop()
const noexcept {
return {}; }
196 impl::TagWriter GetTagWriter();
201 friend class impl::TagWriter;
203 void DoLog()
noexcept;
205 void InternalLoggingError(std::string_view message)
noexcept;
207 void PutFloatingPoint(
float value);
208 void PutFloatingPoint(
double value);
209 void PutFloatingPoint(
long double value);
210 void PutUnsigned(
unsigned long long value);
211 void PutSigned(
long long value);
212 void PutBoolean(
bool value);
213 void Put(std::string_view value);
214 void Put(
char value);
216 void PutRaw(std::string_view value_needs_no_escaping);
217 void PutException(
const std::exception& ex);
218 void PutQuoted(std::string_view value);
220 void VFormat(fmt::string_view fmt, fmt::format_args args)
noexcept;
222 template <
typename T>
223 void PutRangeElement(
const T& value);
225 template <
typename T,
typename U>
226 void PutMapElement(
const std::pair<
const T, U>& value);
228 template <
typename T>
229 void PutRange(
const T& range);
231 std::ostream& Stream();
235 std::unique_ptr<Impl> pimpl_;
77class LogHelper
final {
…};
238inline LogHelper& operator<<(LogHelper& lh, std::error_code ec) {
239 lh << ec.category().name() <<
':' << ec.value() <<
" (" << ec.message() <<
')';
244LogHelper& operator<<(LogHelper& lh,
const std::atomic<T>& value) {
245 return lh << value.load();
249LogHelper& operator<<(LogHelper& lh,
const T* value)
noexcept {
250 if (value ==
nullptr) {
251 lh << std::string_view{
"(null)"};
252 }
else if constexpr (std::is_same_v<T,
char>) {
253 lh << std::string_view{value};
261LogHelper& operator<<(LogHelper& lh, T* value) {
263 !std::is_function_v<T>,
264 "An attempt to log the function address is denied. If you really know what you're doing, cast it to void*."
266 return lh <<
static_cast<
const T*>(value);
270LogHelper& operator<<(LogHelper& lh,
const std::optional<T>& value) {
278template <
class Result,
class... Args>
279LogHelper& operator<<(LogHelper& lh, Result (*)(Args...)) {
280 static_assert(!
sizeof(Result),
"Outputting functions or std::ostream formatters is forbidden");
284LogHelper& operator<<(LogHelper& lh, std::chrono::system_clock::time_point tp);
285LogHelper& operator<<(LogHelper& lh, std::chrono::seconds value);
286LogHelper& operator<<(LogHelper& lh, std::chrono::milliseconds value);
287LogHelper& operator<<(LogHelper& lh, std::chrono::microseconds value);
288LogHelper& operator<<(LogHelper& lh, std::chrono::nanoseconds value);
289LogHelper& operator<<(LogHelper& lh, std::chrono::minutes value);
290LogHelper& operator<<(LogHelper& lh, std::chrono::nanoseconds value);
291LogHelper& operator<<(LogHelper& lh, std::chrono::hours value);
294void LogHelper::PutRangeElement(
const T& value) {
295 if constexpr (std::is_constructible_v<std::string_view, T>) {
296 *
this << Quoted{value};
302template <
typename T,
typename U>
303void LogHelper::PutMapElement(
const std::pair<
const T, U>& value) {
304 PutRangeElement(value.first);
306 PutRangeElement(value.second);
310void LogHelper::PutRange(
const T& range) {
311 static_assert(meta::kIsRange<T>);
316 !std::is_same_v<meta::RangeValueType<T>,
char>,
317 "You should either manually convert type to 'std::string_view' or provide 'operator<<' specialization for your "
318 "type: 'logging::LogHelper& operator<<(logging::LogHelper& lh, const T& value)' or make your type convertible "
319 "to 'std::string_view'"
322 constexpr std::string_view kSeparator =
", ";
325 bool is_first =
true;
326 auto curr = begin(range);
327 const auto end_iter = end(range);
329 while (curr != end_iter) {
330 if (IsLimitReached()) {
339 if constexpr (meta::kIsMap<T>) {
340 PutMapElement(*curr);
342 PutRangeElement(*curr);
347 const auto extra_elements = std::distance(curr, end_iter);
349 if (extra_elements != 0) {
353 *
this <<
"..." << extra_elements <<
" more";
359template <
typename... Args>
360LogHelper& LogHelper::Format(fmt::format_string<Args...> fmt, Args&&... args)
noexcept {
361 VFormat(fmt::string_view(fmt), fmt::make_format_args(args...));