kcenon::monitoring::metric_collector_plugin Class Reference

#include <plugin_metric_collector.h>

Inheritance diagram for kcenon::monitoring::metric_collector_plugin:

Collaboration diagram for kcenon::monitoring::metric_collector_plugin:

Public Member Functions
virtual	~metric_collector_plugin ()=default
virtual bool	initialize (const std::unordered_map< std::string, std::string > &config)=0
virtual std::vector< metric >	collect ()=0
virtual std::string	get_name () const =0
virtual std::vector< std::string >	get_metric_types () const =0
virtual bool	is_healthy () const =0
virtual std::unordered_map< std::string, double >	get_statistics () const =0

Detailed Description

Plugin interface for metric collectors All metric collector plugins must implement this interface

Definition at line 42 of file plugin_metric_collector.h.

Constructor & Destructor Documentation

~metric_collector_plugin()

virtual kcenon::monitoring::metric_collector_plugin::~metric_collector_plugin ( )

virtualdefault

Member Function Documentation

collect()

virtual std::vector< metric > kcenon::monitoring::metric_collector_plugin::collect ( )

pure virtual

Collect metrics from the data source

Returns

Collection of metrics

Implemented in kcenon::monitoring::plugins::container_plugin, kcenon::monitoring::plugins::hardware_plugin, and kcenon::monitoring::system_resource_collector.

get_metric_types()

virtual std::vector< std::string > kcenon::monitoring::metric_collector_plugin::get_metric_types ( ) const

pure virtual

Get supported metric types

Returns

Vector of supported metric type names

Implemented in kcenon::monitoring::plugins::container_plugin, kcenon::monitoring::plugins::hardware_plugin, and kcenon::monitoring::system_resource_collector.

get_name()

virtual std::string kcenon::monitoring::metric_collector_plugin::get_name ( ) const

pure virtual

Get the name of this plugin

Returns

Plugin name

Implemented in kcenon::monitoring::plugins::container_plugin, kcenon::monitoring::plugins::hardware_plugin, and kcenon::monitoring::system_resource_collector.

get_statistics()

virtual std::unordered_map< std::string, double > kcenon::monitoring::metric_collector_plugin::get_statistics ( ) const

pure virtual

Get plugin-specific statistics

Returns

Map of statistic name to value

Implemented in kcenon::monitoring::plugins::container_plugin, kcenon::monitoring::plugins::hardware_plugin, and kcenon::monitoring::system_resource_collector.

initialize()

virtual bool kcenon::monitoring::metric_collector_plugin::initialize ( const std::unordered_map< std::string, std::string > & config )

pure virtual

Initialize the plugin with configuration

Parameters

config

Plugin-specific configuration

Returns

true if initialization successful

Implemented in kcenon::monitoring::plugins::container_plugin, kcenon::monitoring::plugins::hardware_plugin, and kcenon::monitoring::system_resource_collector.

is_healthy()

virtual bool kcenon::monitoring::metric_collector_plugin::is_healthy ( ) const

pure virtual

Check if the plugin is healthy

Returns

true if plugin is operational

Implemented in kcenon::monitoring::plugins::container_plugin, kcenon::monitoring::plugins::hardware_plugin, and kcenon::monitoring::system_resource_collector.

---

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

• include/kcenon/monitoring/collectors/plugin_metric_collector.h