components::LoggingConfigurator Class Reference

#include <userver/components/logging_configurator.hpp>

Detailed Description

Helper component to configure logging.

The functionality is not in Trace or Logger components because that introduces circular dependency between Logger and DynamicConfig.

LoggingConfigurator Dynamic config

• USERVER_LOG_DYNAMIC_DEBUG
• USERVER_NO_LOG_SPANS

Static options of components::LoggingConfigurator :

Name	Description	Default value
limited-logging-enable	Set to true to make LOG_LIMITED drop repeated logs.	–
limited-logging-interval	Utils::StringToDuration suitable duration string to group repeated logs into one message.	–

Options inherited from components::ComponentBase :

Name	Description	Default value
load-enabled	Set to false to disable loading of the component.	true

Config example:

# yaml
    logging-configurator:
      limited-logging-enable: true
      limited-logging-interval: 1s

Definition at line 41 of file logging_configurator.hpp.

Inheritance diagram for components::LoggingConfigurator:

Public Member Functions
	LoggingConfigurator (const ComponentConfig &config, const ComponentContext &context)
virtual ComponentHealth	GetComponentHealth () const
virtual void	OnLoadingCancelled ()
virtual void	OnAllComponentsLoaded ()
virtual void	OnAllComponentsAreStopping ()

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

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

Member Function Documentation

GetComponentHealth()

virtual ComponentHealth components::RawComponentBase::GetComponentHealth ( ) const

inlinevirtualinherited

Reimplemented in components::ComponentBase, and server::handlers::Restart.

Definition at line 52 of file raw_component_base.hpp.

OnAllComponentsAreStopping()

virtual void components::RawComponentBase::OnAllComponentsAreStopping ( )

inlinevirtualinherited

Reimplemented in components::ComponentBase, components::Server, and urabbitmq::ConsumerComponentBase.

Definition at line 58 of file raw_component_base.hpp.

OnAllComponentsLoaded()

virtual void components::RawComponentBase::OnAllComponentsLoaded ( )

inlinevirtualinherited

Reimplemented in components::ComponentBase, components::Server, server::handlers::Ping, and urabbitmq::ConsumerComponentBase.

Definition at line 56 of file raw_component_base.hpp.

OnLoadingCancelled()

virtual void components::RawComponentBase::OnLoadingCancelled ( )

inlinevirtualinherited

Reimplemented in components::ComponentBase.

Definition at line 54 of file raw_component_base.hpp.

---

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

• userver/components/logging_configurator.hpp