userver: userver/utils/statistics/pretty_format.hpp Source File
Loading...
Searching...
No Matches
pretty_format.hpp
Go to the documentation of this file.
1#pragma once
2
3/// @file userver/utils/statistics/pretty_format.hpp
4/// @brief Statistics output in human-readable format.
5
6#include <string>
7
8#include <userver/utils/statistics/storage.hpp>
9
10USERVER_NAMESPACE_BEGIN
11
12namespace utils::statistics {
13
14/// @brief Output `statistics` in a human-readable, compact format, useful for
15/// visual inspection.
16///
17/// @warning This format is unstable, we reserve the right to change it at any
18/// point. Don't use it in scripts, use utils::statistics::ToJsonFormat instead!
19///
20/// The current version of this unstable format is:
21/// @code
22/// metric-path: some-label=label-value, other-label=other-label-value\tRATE\t42
23/// @endcode
24std::string ToPrettyFormat(
25 const utils::statistics::Storage& statistics,
26 const utils::statistics::Request& statistics_request = {});
27
28} // namespace utils::statistics
29
30USERVER_NAMESPACE_END