logging_configurator.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/components/logging_configurator.hpp
/// @brief @copybrief components::LoggingConfigurator
 
#include <userver/components/component_fwd.hpp>
#include <userver/components/impl/component_base.hpp>
#include <userver/concurrent/async_event_source.hpp>
#include <userver/dynamic_config/source.hpp>
#include <userver/rcu/rcu.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace logging {
struct DynamicDebugConfig;
}
 
namespace components {
 
// clang-format off
 
/// @ingroup userver_components
///
/// @brief Helper component to configure logging.
///
/// The functionality is not in Trace or Logger components because that
/// introduces circular dependency between Logger and DynamicConfig.
///
/// ## Dynamic config
/// * @ref USERVER_LOG_DYNAMIC_DEBUG
/// * @ref USERVER_NO_LOG_SPANS
///
/// ## Static options:
/// 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 | -
///
/// ## Config example:
///
/// @snippet components/common_component_list_test.cpp Sample logging configurator component config
 
// clang-format on
class LoggingConfigurator final : public impl::ComponentBase {
 public:
  /// @ingroup userver_component_names
  /// @brief The default name of components::LoggingConfigurator component
  static constexpr std::string_view kName = "logging-configurator";
 
  LoggingConfigurator(const ComponentConfig& config,
                      const ComponentContext& context);
 
  ~LoggingConfigurator() override;
 
  static yaml_config::Schema GetStaticConfigSchema();
 
 private:
  void OnConfigUpdate(const dynamic_config::Snapshot& config);
 
  concurrent::AsyncEventSubscriberScope config_subscription_;
  rcu::Variable<logging::DynamicDebugConfig> dynamic_debug_;
};
 
/// }@
 
template <>
inline constexpr bool kHasValidate<LoggingConfigurator> = true;
 
}  // namespace components
 
USERVER_NAMESPACE_END