Monitoring System 0.1.0
System resource monitoring with pluggable collectors and alerting
Loading...
Searching...
No Matches
kcenon::monitoring::uptime_collector Class Reference

System uptime monitoring collector implementing collector_plugin interface. More...

#include <uptime_collector.h>

Inheritance diagram for kcenon::monitoring::uptime_collector:
Inheritance graph
Collaboration diagram for kcenon::monitoring::uptime_collector:
Collaboration graph

Public Member Functions

 uptime_collector ()
 
 ~uptime_collector () override=default
 
 uptime_collector (const uptime_collector &)=delete
 
uptime_collectoroperator= (const uptime_collector &)=delete
 
 uptime_collector (uptime_collector &&)=delete
 
uptime_collectoroperator= (uptime_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
 
auto get_statistics () const -> stats_map override
 
uptime_metrics get_last_metrics () const
 
bool is_uptime_monitoring_available () const
 
- Public Member Functions inherited from kcenon::monitoring::collector_plugin
virtual ~collector_plugin ()=default
 
virtual void shutdown ()
 Shutdown plugin and release resources.
 

Private Member Functions

void add_uptime_metrics (std::vector< metric > &metrics, const uptime_metrics &uptime_data)
 

Private Attributes

std::unique_ptr< uptime_info_collectorcollector_
 
bool enabled_ {true}
 
bool collect_idle_time_ {true}
 
uptime_metrics last_metrics_
 
std::atomic< size_t > collection_count_ {0}
 
std::atomic< size_t > collection_errors_ {0}
 

Detailed Description

System uptime monitoring collector implementing collector_plugin interface.

Collects system uptime metrics with cross-platform support. Provides boot timestamp and uptime duration for availability tracking.

Definition at line 94 of file uptime_collector.h.

Constructor & Destructor Documentation

◆ uptime_collector() [1/3]

kcenon::monitoring::uptime_collector::uptime_collector ( )

◆ ~uptime_collector()

kcenon::monitoring::uptime_collector::~uptime_collector ( )
overridedefault

◆ uptime_collector() [2/3]

kcenon::monitoring::uptime_collector::uptime_collector ( const uptime_collector & )
delete

◆ uptime_collector() [3/3]

kcenon::monitoring::uptime_collector::uptime_collector ( uptime_collector && )
delete

Member Function Documentation

◆ add_uptime_metrics()

void kcenon::monitoring::uptime_collector::add_uptime_metrics ( std::vector< metric > & metrics,
const uptime_metrics & uptime_data )
private

◆ collect()

auto kcenon::monitoring::uptime_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.

◆ get_last_metrics()

uptime_metrics kcenon::monitoring::uptime_collector::get_last_metrics ( ) const

Get last collected uptime metrics

Returns
Most recent uptime_metrics reading

◆ get_metadata()

auto kcenon::monitoring::uptime_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 112 of file uptime_collector.h.

112 {
113 return plugin_metadata{
114 .name = name(),
115 .description = "System uptime metrics (boot time, uptime duration)",
116 .category = plugin_category::platform,
117 .version = "1.0.0",
118 .dependencies = {},
119 .requires_platform_support = true
120 };
121 }
auto name() const -> std::string_view override
Get the unique name of this plugin.
@ platform
Platform-specific (VM, uptime, interrupts)

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

Here is the call graph for this function:

◆ get_metric_types()

auto kcenon::monitoring::uptime_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::uptime_collector::get_statistics ( ) const -> stats_map
overridevirtual

Get collector statistics

Returns
Map of statistic name to value

Reimplemented from kcenon::monitoring::collector_plugin.

◆ initialize()

auto kcenon::monitoring::uptime_collector::initialize ( const config_map & config) -> bool
overridevirtual

Initialize the collector with configuration

Parameters
configConfiguration options:
  • "collect_idle_time": "true"/"false" (default: true, Linux only)
Returns
true if initialization successful

Reimplemented from kcenon::monitoring::collector_plugin.

◆ interval()

auto kcenon::monitoring::uptime_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 108 of file uptime_collector.h.

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

◆ is_available()

auto kcenon::monitoring::uptime_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_uptime_monitoring_available()

bool kcenon::monitoring::uptime_collector::is_uptime_monitoring_available ( ) const

Check if uptime monitoring is available

Returns
True if uptime metrics are accessible

◆ name()

auto kcenon::monitoring::uptime_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 106 of file uptime_collector.h.

106{ return "uptime"; }

Referenced by get_metadata().

Here is the caller graph for this function:

◆ operator=() [1/2]

uptime_collector & kcenon::monitoring::uptime_collector::operator= ( const uptime_collector & )
delete

◆ operator=() [2/2]

uptime_collector & kcenon::monitoring::uptime_collector::operator= ( uptime_collector && )
delete

Member Data Documentation

◆ collect_idle_time_

bool kcenon::monitoring::uptime_collector::collect_idle_time_ {true}
private

Definition at line 154 of file uptime_collector.h.

154{true};

◆ collection_count_

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

Definition at line 160 of file uptime_collector.h.

160{0};

◆ collection_errors_

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

Definition at line 161 of file uptime_collector.h.

161{0};

◆ collector_

std::unique_ptr<uptime_info_collector> kcenon::monitoring::uptime_collector::collector_
private

Definition at line 150 of file uptime_collector.h.

◆ enabled_

bool kcenon::monitoring::uptime_collector::enabled_ {true}
private

Definition at line 153 of file uptime_collector.h.

153{true};

◆ last_metrics_

uptime_metrics kcenon::monitoring::uptime_collector::last_metrics_
private

Definition at line 157 of file uptime_collector.h.


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