components::SystemStatisticsCollector Class Reference

Table of Contents

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

Component for system resource usage statistics collection. More...

#include <userver/utils/statistics/system_statistics_collector.hpp>

Inheritance diagram for components::SystemStatisticsCollector:

Collaboration diagram for components::SystemStatisticsCollector:

Public Member Functions
	SystemStatisticsCollector (const ComponentConfig &, const ComponentContext &)
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 = "system-statistics-collector"
	The default name of components::SystemStatisticsCollector.

Detailed Description

Component for system resource usage statistics collection.

Periodically queries resource usage info and reports is as a set of metrics.

Static options:

Name	Description	Default value
fs-task-processor	Task processor to use for statistics gathering	-
with-nginx	Whether to collect and report nginx processes statistics	false

Note that with-nginx is a relatively expensive option as it requires full process list scan.

Static configuration example:

    system-statistics-collector:
      fs-task-processor: fs-task-processor
      with-nginx: false

Definition at line 38 of file system_statistics_collector.hpp.

---

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

• userver/utils/statistics/system_statistics_collector.hpp