Battery status monitoring collector implementing collector_plugin interface. More...

#include <battery_collector.h>

Inheritance diagram for kcenon::monitoring::battery_collector:

Collaboration diagram for kcenon::monitoring::battery_collector:

Public Member Functions
	battery_collector ()

	~battery_collector () override=default

	battery_collector (const battery_collector &)=delete

battery_collector &	operator= (const battery_collector &)=delete

	battery_collector (battery_collector &&)=delete

battery_collector &	operator= (battery_collector &&)=delete

auto	name () const -> std::string_view override
	Get the unique name of this plugin.

auto	collect () -> std::vector< metric > override
	Collect current metrics from this plugin.

auto	interval () const -> std::chrono::milliseconds override
	Get the collection interval for this plugin.

auto	is_available () const -> bool override
	Check if this plugin is available on the current system.

auto	get_metric_types () const -> std::vector< std::string > override
	Get supported metric types.

auto	get_metadata () const -> plugin_metadata override
	Get plugin metadata.

auto	initialize (const config_map &config) -> bool override
	Initialize plugin with configuration.

void	shutdown () override
	Shutdown plugin and release resources.

auto	get_statistics () const -> stats_map override
	Get plugin statistics.

std::vector< battery_reading >	get_last_readings () const

bool	is_battery_available () const

Public Member Functions inherited from kcenon::monitoring::collector_plugin
virtual	~collector_plugin ()=default

Private Member Functions
metric	create_battery_metric (const std::string &name, double value, const battery_reading &reading, const std::string &unit="") const

void	add_battery_metrics (std::vector< metric > &metrics, const battery_reading &reading)

Private Attributes
std::unique_ptr< battery_info_collector >	collector_

bool	collect_health_ {true}

bool	collect_thermal_ {true}

std::mutex	stats_mutex_

std::atomic< size_t >	batteries_found_ {0}

std::atomic< size_t >	collection_count_ {0}

std::atomic< size_t >	collection_errors_ {0}

std::vector< battery_reading >	last_readings_

Detailed Description

Battery status monitoring collector implementing collector_plugin interface.

Collects battery status metrics from available batteries with cross-platform support. Returns empty/default metrics when no battery is present.

Definition at line 172 of file battery_collector.h.

Constructor & Destructor Documentation

◆ battery_collector() [1/3]

kcenon::monitoring::battery_collector::battery_collector ( )

◆ ~battery_collector()

kcenon::monitoring::battery_collector::~battery_collector ( )

overridedefault

◆ battery_collector() [2/3]

kcenon::monitoring::battery_collector::battery_collector ( const battery_collector & )

delete

◆ battery_collector() [3/3]

kcenon::monitoring::battery_collector::battery_collector ( battery_collector && )

delete

Member Function Documentation

◆ add_battery_metrics()

void kcenon::monitoring::battery_collector::add_battery_metrics	(	std::vector< metric > &	metrics,
		const battery_reading &	reading )

private

◆ collect()

auto kcenon::monitoring::battery_collector::collect ( ) -> std::vector< metric >

overridevirtual

Collect current metrics from this plugin.

Returns: Vector of collected metrics

This method is called periodically based on interval(). Implementations should:

Return quickly (< 100ms recommended)
Handle errors gracefully (return empty vector on failure)
Be thread-safe if concurrent collection is enabled
Avoid blocking I/O when possible

Implements kcenon::monitoring::collector_plugin.

◆ create_battery_metric()

metric kcenon::monitoring::battery_collector::create_battery_metric	(	const std::string &	name,
		double	value,
		const battery_reading &	reading,
		const std::string &	unit = "" ) const

private

◆ get_last_readings()

std::vector< battery_reading > kcenon::monitoring::battery_collector::get_last_readings ( ) const

Get last collected battery readings

Returns: Vector of battery readings

◆ get_metadata()

auto kcenon::monitoring::battery_collector::get_metadata ( ) const -> plugin_metadata

inlineoverridevirtual

Get plugin metadata.

Returns: Metadata describing this plugin

Default implementation returns minimal metadata. Override to provide rich plugin information.

Reimplemented from kcenon::monitoring::collector_plugin.

Definition at line 190 of file battery_collector.h.

                                                          {
        return plugin_metadata{
            .name = name(),
            .description = "Battery status metrics (charge, health, temperature)",
            .category = plugin_category::hardware,
            .version = "1.0.0",
            .dependencies = {},
            .requires_platform_support = true
        };
    }

References kcenon::monitoring::hardware, and name().

Here is the call graph for this function:

◆ get_metric_types()

auto kcenon::monitoring::battery_collector::get_metric_types ( ) const -> std::vector< std::string >

overridevirtual

Get supported metric types.

Returns: Vector of metric type names this plugin produces

Used for filtering and documentation.

Implements kcenon::monitoring::collector_plugin.

◆ get_statistics()

auto kcenon::monitoring::battery_collector::get_statistics ( ) const -> stats_map

overridevirtual

Get plugin statistics.

Returns: Map of statistic name to value

Optional: Override to provide plugin-specific statistics.

Reimplemented from kcenon::monitoring::collector_plugin.

◆ initialize()

auto kcenon::monitoring::battery_collector::initialize ( const config_map & ) -> bool

overridevirtual

Initialize plugin with configuration.

Parameters

config Configuration key-value pairs

Returns: True if initialization succeeded

Called once after plugin registration. Optional: Default implementation always succeeds.

Reimplemented from kcenon::monitoring::collector_plugin.

◆ interval()

auto kcenon::monitoring::battery_collector::interval ( ) const -> std::chrono::milliseconds

inlineoverridevirtual

Get the collection interval for this plugin.

Returns: Collection interval in milliseconds

The registry uses this value to schedule collection tasks. Typical values:

Fast metrics (CPU, memory): 1-5 seconds
Slow metrics (disk, network): 10-60 seconds
Very slow metrics (SMART data): 5-15 minutes

Implements kcenon::monitoring::collector_plugin.

Definition at line 186 of file battery_collector.h.

186{ return std::chrono::seconds(30); }

◆ is_available()

auto kcenon::monitoring::battery_collector::is_available ( ) const -> bool

overridevirtual

Check if this plugin is available on the current system.

Returns: True if plugin can collect metrics, false otherwise

Availability checks may include:

Platform compatibility (Linux-only, Windows-only)
Hardware presence (GPU, sensors)
Permission checks (root required)
Resource availability (proc filesystem, WMI)

The registry may skip unavailable plugins during registration.

Implements kcenon::monitoring::collector_plugin.

◆ is_battery_available()

bool kcenon::monitoring::battery_collector::is_battery_available ( ) const

Check if battery monitoring is available

Returns: True if batteries are accessible

◆ name()

auto kcenon::monitoring::battery_collector::name ( ) const -> std::string_view

inlineoverridevirtual

Get the unique name of this plugin.

Returns: Plugin name (must be unique within registry)

The name is used for:

Plugin lookup and discovery
Configuration mapping
Metric tagging (added as "collector" tag)

Implements kcenon::monitoring::collector_plugin.

Definition at line 184 of file battery_collector.h.

184{ return "battery"; }

Referenced by get_metadata().

Here is the caller graph for this function:

◆ operator=() [1/2]

battery_collector & kcenon::monitoring::battery_collector::operator= ( battery_collector && )

delete

◆ operator=() [2/2]

battery_collector & kcenon::monitoring::battery_collector::operator= ( const battery_collector & )

delete

◆ shutdown()

void kcenon::monitoring::battery_collector::shutdown ( )

inlineoverridevirtual

Shutdown plugin and release resources.

Called before plugin destruction. Optional: Default implementation is no-op.

Reimplemented from kcenon::monitoring::collector_plugin.

Definition at line 202 of file battery_collector.h.

202{}

Member Data Documentation

◆ batteries_found_

std::atomic<size_t> kcenon::monitoring::battery_collector::batteries_found_ {0}

private

Definition at line 226 of file battery_collector.h.

226{0};

◆ collect_health_

bool kcenon::monitoring::battery_collector::collect_health_ {true}

private

Definition at line 221 of file battery_collector.h.

221{true};

◆ collect_thermal_

bool kcenon::monitoring::battery_collector::collect_thermal_ {true}

private

Definition at line 222 of file battery_collector.h.

222{true};

◆ collection_count_

std::atomic<size_t> kcenon::monitoring::battery_collector::collection_count_ {0}

private

Definition at line 227 of file battery_collector.h.

227{0};

◆ collection_errors_

std::atomic<size_t> kcenon::monitoring::battery_collector::collection_errors_ {0}

private

Definition at line 228 of file battery_collector.h.

228{0};

◆ collector_

std::unique_ptr<battery_info_collector> kcenon::monitoring::battery_collector::collector_

private

Definition at line 218 of file battery_collector.h.

◆ last_readings_

std::vector<battery_reading> kcenon::monitoring::battery_collector::last_readings_

private

Definition at line 229 of file battery_collector.h.

◆ stats_mutex_

std::mutex kcenon::monitoring::battery_collector::stats_mutex_

mutableprivate

Definition at line 225 of file battery_collector.h.

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

include/kcenon/monitoring/collectors/battery_collector.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ battery_collector() [1/3]

◆ ~battery_collector()

◆ battery_collector() [2/3]

◆ battery_collector() [3/3]

Member Function Documentation

◆ add_battery_metrics()

◆ collect()

◆ create_battery_metric()

◆ get_last_readings()

◆ get_metadata()

◆ get_metric_types()

◆ get_statistics()

◆ initialize()

◆ interval()

◆ is_available()

◆ is_battery_available()

◆ name()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ shutdown()

Member Data Documentation

◆ batteries_found_

◆ collect_health_

◆ collect_thermal_

◆ collection_count_

◆ collection_errors_

◆ collector_

◆ last_readings_

◆ stats_mutex_