components::DumpConfigurator Class Reference

Table of Contents

• Detailed Description
• Static options:
• Config example:
• Public Member Functions
• Static Public Member Functions
• Static Public Attributes

#include <userver/components/dump_configurator.hpp>

Detailed Description

Helper component that manages common configuration for userver dumps.

The component must be configured in service config.

Static options:

Name	Description	Default value
dump-root	Components store dumps in subdirectories of this directory	-

Config example:

    dump-configurator:
      dump-root: $userver-dumps-root

Definition at line 30 of file dump_configurator.hpp.

Inheritance diagram for components::DumpConfigurator:

Collaboration diagram for components::DumpConfigurator:

Public Member Functions
	DumpConfigurator (const ComponentConfig &config, const ComponentContext &context)
const std::string &	GetDumpRoot () const
Public Member Functions inherited from components::LoggableComponentBase
	LoggableComponentBase (const ComponentConfig &, const ComponentContext &)
	LoggableComponentBase (LoggableComponentBase &&)=delete
	LoggableComponentBase (const LoggableComponentBase &)=delete
	~LoggableComponentBase () override=default
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()
Static Public Member Functions inherited from components::LoggableComponentBase
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Attributes
static constexpr std::string_view	kName = "dump-configurator"
	The default name of components::DumpConfigurator component.

---

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

• userver/components/dump_configurator.hpp