userver
C++ Async Framework
Toggle main menu visibility
Documentation
API Groups
Namespaces
Reference
Class List
Class Index
File List
Macros
All
e
i
l
r
t
u
Functions
Macros
e
i
l
r
t
u
Examples
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Modules
Pages
Concepts
Loading...
Searching...
No Matches
dump_configurator.hpp
1
#
pragma
once
2
3
#
include
<
string
>
4
5
#
include
<
userver
/
components
/
component_base
.
hpp
>
6
#
include
<
userver
/
components
/
component_fwd
.
hpp
>
7
8
USERVER_NAMESPACE_BEGIN
9
10
namespace
components
{
11
12
// clang-format off
13
14
/// @ingroup userver_components
15
///
16
/// @brief Helper component that manages common configuration for userver dumps.
17
///
18
/// The component must be configured in service config.
19
///
20
/// ## Static options:
21
/// Name | Description | Default value
22
/// ---- | ----------- | -------------
23
/// dump-root | Components store dumps in subdirectories of this directory | -
24
///
25
/// ## Config example:
26
///
27
/// @snippet components/common_component_list_test.cpp Sample dump configurator component config
28
29
// clang-format on
30
class
DumpConfigurator
final
:
public
ComponentBase
{
31
public
:
32
/// @ingroup userver_component_names
33
/// @brief The default name of components::DumpConfigurator component
34
static
constexpr
std::string_view
kName
=
"dump-configurator"
;
35
36
DumpConfigurator(
const
ComponentConfig& config,
const
ComponentContext& context);
37
38
const
std::string& GetDumpRoot()
const
;
39
40
static
yaml_config
::Schema GetStaticConfigSchema();
41
42
private
:
43
const
std::string dump_root_;
44
};
30
class
DumpConfigurator
final
:
public
ComponentBase
{
…
};
45
46
template
<>
47
inline
constexpr
bool
kHasValidate<DumpConfigurator> =
true
;
48
49
}
// namespace components
50
51
USERVER_NAMESPACE_END
userver
components
dump_configurator.hpp
Generated on Fri Apr 11 2025 14:18:43 for userver by
Doxygen
1.13.2