userver: alerts::StorageComponent Class Reference
Loading...
Searching...
No Matches
alerts::StorageComponent Class Referencefinal

#include <userver/alerts/component.hpp>

Detailed Description

Component that keeps an alert::Storage storage for fired alerts.

The component does not have any options for service config.

Static configuration example:

# yaml
statistics-storage:
# Nothing

Definition at line 30 of file component.hpp.

+ Inheritance diagram for alerts::StorageComponent:

Public Member Functions

 StorageComponent (const components::ComponentConfig &config, const components::ComponentContext &context)
 
StorageGetStorage () const
 
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 = "alerts-storage"
 The default name of alert::StorageComponent component.
 

Member Function Documentation

◆ GetComponentHealth()

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

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

Definition at line 49 of file raw_component_base.hpp.

◆ OnAllComponentsAreStopping()

virtual void components::RawComponentBase::OnAllComponentsAreStopping ( )
inlinevirtualinherited

◆ OnAllComponentsLoaded()

virtual void components::RawComponentBase::OnAllComponentsLoaded ( )
inlinevirtualinherited

◆ OnLoadingCancelled()

virtual void components::RawComponentBase::OnLoadingCancelled ( )
inlinevirtualinherited

Reimplemented in components::ComponentBase.

Definition at line 51 of file raw_component_base.hpp.


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