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

#include <smart_collector.h>

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

Public Member Functions

 smart_collector ()
 
 ~smart_collector ()=default
 
 smart_collector (const smart_collector &)=delete
 
smart_collectoroperator= (const smart_collector &)=delete
 
 smart_collector (smart_collector &&)=delete
 
smart_collectoroperator= (smart_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.
 
bool is_healthy () const
 
auto get_metric_types () const -> std::vector< std::string > override
 Get supported metric types.
 
bool initialize (const std::unordered_map< std::string, std::string > &config) override
 
std::unordered_map< std::string, double > get_statistics () const override
 
std::vector< smart_disk_metricsget_last_metrics () const
 
bool is_smart_available () const
 
- Public Member Functions inherited from kcenon::monitoring::collector_plugin
virtual ~collector_plugin ()=default
 
virtual auto get_metadata () const -> plugin_metadata
 Get plugin metadata.
 
virtual void shutdown ()
 Shutdown plugin and release resources.
 

Private Member Functions

metric create_metric (const std::string &name, double value, const smart_disk_metrics &disk, const std::string &unit="") const
 
void add_disk_metrics (std::vector< metric > &metrics, const smart_disk_metrics &disk)
 

Private Attributes

std::unique_ptr< smart_info_collectorcollector_
 
bool enabled_ {true}
 
bool collect_temperature_ {true}
 
bool collect_error_rates_ {true}
 
std::chrono::milliseconds collection_interval_ {std::chrono::seconds(300)}
 
std::mutex stats_mutex_
 
std::atomic< size_t > collection_count_ {0}
 
std::atomic< size_t > collection_errors_ {0}
 
std::atomic< size_t > disks_found_ {0}
 
std::vector< smart_disk_metricslast_metrics_
 

Detailed Description

SMART disk health collector implementing the collector_plugin interface

Collects S.M.A.R.T. disk health data using smartctl (smartmontools). Gracefully degrades when smartctl is not available or disks don't support SMART.

Definition at line 121 of file smart_collector.h.

Constructor & Destructor Documentation

◆ smart_collector() [1/3]

kcenon::monitoring::smart_collector::smart_collector ( )

◆ ~smart_collector()

kcenon::monitoring::smart_collector::~smart_collector ( )
default

◆ smart_collector() [2/3]

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

◆ smart_collector() [3/3]

kcenon::monitoring::smart_collector::smart_collector ( smart_collector && )
delete

Member Function Documentation

◆ add_disk_metrics()

void kcenon::monitoring::smart_collector::add_disk_metrics ( std::vector< metric > & metrics,
const smart_disk_metrics & disk )
private

◆ collect()

auto kcenon::monitoring::smart_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_metric()

metric kcenon::monitoring::smart_collector::create_metric ( const std::string & name,
double value,
const smart_disk_metrics & disk,
const std::string & unit = "" ) const
private

◆ get_last_metrics()

std::vector< smart_disk_metrics > kcenon::monitoring::smart_collector::get_last_metrics ( ) const

Get last collected SMART metrics

Returns
Vector of SMART disk metrics

◆ get_metric_types()

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

std::unordered_map< std::string, double > kcenon::monitoring::smart_collector::get_statistics ( ) const
overridevirtual

Get collector statistics

Returns
Map of statistic name to value

Reimplemented from kcenon::monitoring::collector_plugin.

◆ initialize()

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

Initialize the collector with configuration

Parameters
configConfiguration options
Returns
true if initialization successful

Reimplemented from kcenon::monitoring::collector_plugin.

◆ interval()

auto kcenon::monitoring::smart_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 135 of file smart_collector.h.

135{ return collection_interval_; }
std::chrono::milliseconds collection_interval_

References collection_interval_.

◆ is_available()

auto kcenon::monitoring::smart_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_healthy()

bool kcenon::monitoring::smart_collector::is_healthy ( ) const

Check if collector is in a healthy state

Returns
True if collector is operational

◆ is_smart_available()

bool kcenon::monitoring::smart_collector::is_smart_available ( ) const

Check if SMART monitoring is available

Returns
True if smartctl is available

◆ name()

auto kcenon::monitoring::smart_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 133 of file smart_collector.h.

133{ return "smart_collector"; }

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Member Data Documentation

◆ collect_error_rates_

bool kcenon::monitoring::smart_collector::collect_error_rates_ {true}
private

Definition at line 176 of file smart_collector.h.

176{true};

◆ collect_temperature_

bool kcenon::monitoring::smart_collector::collect_temperature_ {true}
private

Definition at line 175 of file smart_collector.h.

175{true};

◆ collection_count_

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

Definition at line 181 of file smart_collector.h.

181{0};

◆ collection_errors_

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

Definition at line 182 of file smart_collector.h.

182{0};

◆ collection_interval_

std::chrono::milliseconds kcenon::monitoring::smart_collector::collection_interval_ {std::chrono::seconds(300)}
private

Definition at line 177 of file smart_collector.h.

177{std::chrono::seconds(300)};

Referenced by interval().

◆ collector_

std::unique_ptr<smart_info_collector> kcenon::monitoring::smart_collector::collector_
private

Definition at line 171 of file smart_collector.h.

◆ disks_found_

std::atomic<size_t> kcenon::monitoring::smart_collector::disks_found_ {0}
private

Definition at line 183 of file smart_collector.h.

183{0};

◆ enabled_

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

Definition at line 174 of file smart_collector.h.

174{true};

◆ last_metrics_

std::vector<smart_disk_metrics> kcenon::monitoring::smart_collector::last_metrics_
private

Definition at line 184 of file smart_collector.h.

◆ stats_mutex_

std::mutex kcenon::monitoring::smart_collector::stats_mutex_
mutableprivate

Definition at line 180 of file smart_collector.h.


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