Container for monitoring metrics from a component. More...

#include <monitorable_interface.h>

Collaboration diagram for kcenon::monitoring::monitoring_data:

Public Types
using	metric_map = std::unordered_map<std::string, double>

using	tag_map = std::unordered_map<std::string, std::string>

Public Member Functions
	monitoring_data ()
	Default constructor.

	monitoring_data (const std::string &name)
	Constructor with component name.

void	add_metric (const std::string &key, double value)
	Add a numeric metric.

void	add_tag (const std::string &key, const std::string &value)
	Add a tag (string metadata)

std::optional< double >	get_metric (const std::string &key) const
	Get a metric value.

std::optional< std::string >	get_tag (const std::string &key) const
	Get a tag value.

const metric_map &	get_metrics () const
	Get all metrics.

const tag_map &	get_tags () const
	Get all tags.

std::chrono::system_clock::time_point	get_timestamp () const
	Get the timestamp.

const std::string &	get_component_name () const
	Get the component name.

void	set_component_name (const std::string &name)
	Set the component name.

void	clear ()
	Clear all metrics and tags.

bool	empty () const
	Check if data is empty.

std::size_t	metric_count () const
	Get the number of metrics.

std::size_t	tag_count () const
	Get the number of tags.

void	merge (const monitoring_data &other, const std::string &prefix="")
	Merge another monitoring_data into this one.

Private Attributes
metric_map	metrics_

tag_map	tags_

std::chrono::system_clock::time_point	timestamp_

std::string	component_name_

Detailed Description

Container for monitoring metrics from a component.

This structure holds key-value pairs of metrics that a component exposes for monitoring purposes. It supports both numeric metrics and string tags for additional metadata.

Thread Safety:: This class is NOT inherently thread-safe. When accessed from multiple threads, external synchronization is required. Consider using mutable with mutex for thread-safe access in derived classes.

Definition at line 63 of file monitorable_interface.h.

Member Typedef Documentation

◆ metric_map

using kcenon::monitoring::monitoring_data::metric_map = std::unordered_map<std::string, double>

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 64 of file monitorable_interface.h.

◆ tag_map

using kcenon::monitoring::monitoring_data::tag_map = std::unordered_map<std::string, std::string>

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 65 of file monitorable_interface.h.

Constructor & Destructor Documentation

◆ monitoring_data() [1/2]

kcenon::monitoring::monitoring_data::monitoring_data ( )

inline

Default constructor.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 77 of file monitorable_interface.h.

78 : timestamp_(std::chrono::system_clock::now()) {}

kcenon::monitoring::monitoring_data::timestamp_

std::chrono::system_clock::time_point timestamp_

Definition monitorable_interface.h:70

◆ monitoring_data() [2/2]

kcenon::monitoring::monitoring_data::monitoring_data ( const std::string & name )

inlineexplicit

Constructor with component name.

Parameters

name	Name of the component being monitored

Definition at line 84 of file monitorable_interface.h.

85 : timestamp_(std::chrono::system_clock::now())

86 , component_name_(name) {}

kcenon::monitoring::monitoring_data::component_name_

std::string component_name_

Definition monitorable_interface.h:71

Member Function Documentation

◆ add_metric()

void kcenon::monitoring::monitoring_data::add_metric	(	const std::string &	key,
		double	value )

inline

Add a numeric metric.

Parameters

key	Metric name
value	Metric value

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 93 of file monitorable_interface.h.

                                                        {
        metrics_[key] = value;
    }

References metrics_.

Referenced by kcenon::monitoring::monitoring_aggregator::collect_all(), MetricExportersTest::create_test_monitoring_data(), test_monitorable_component::get_monitoring_data(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and kcenon::monitoring::monitorable_component::update_metric().

Here is the caller graph for this function:

◆ add_tag()

void kcenon::monitoring::monitoring_data::add_tag	(	const std::string &	key,
		const std::string &	value )

inline

Add a tag (string metadata)

Parameters

key	Tag name
value	Tag value

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 102 of file monitorable_interface.h.

                                                               {
        tags_[key] = value;
    }

References tags_.

Referenced by kcenon::monitoring::monitoring_aggregator::collect_all(), MetricExportersTest::create_test_monitoring_data(), test_monitorable_component::get_monitoring_data(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and kcenon::monitoring::monitorable_component::update_tag().

Here is the caller graph for this function:

◆ clear()

void kcenon::monitoring::monitoring_data::clear ( )

inline

Clear all metrics and tags.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 175 of file monitorable_interface.h.

                 {
        metrics_.clear();
        tags_.clear();
    }

References metrics_, and tags_.

Referenced by kcenon::monitoring::monitorable_component::reset_monitoring(), and TEST_F().

Here is the caller graph for this function:

◆ empty()

bool kcenon::monitoring::monitoring_data::empty ( ) const

inline

Check if data is empty.

Returns: true if no metrics or tags are present

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 184 of file monitorable_interface.h.

                       {
        return metrics_.empty() && tags_.empty();
    }

References metrics_, and tags_.

Referenced by TEST_F(), and TEST_F().

Here is the caller graph for this function:

◆ get_component_name()

const std::string & kcenon::monitoring::monitoring_data::get_component_name ( ) const

inline

Get the component name.

Returns: Name of the monitored component

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 160 of file monitorable_interface.h.

                                                {
        return component_name_;
    }

References component_name_.

Referenced by kcenon::monitoring::prometheus_exporter::convert_monitoring_data(), kcenon::monitoring::statsd_exporter::convert_monitoring_data(), and TEST_F().

Here is the caller graph for this function:

◆ get_metric()

std::optional< double > kcenon::monitoring::monitoring_data::get_metric ( const std::string & key ) const

inline

Get a metric value.

Parameters

key	Metric name

Returns: Optional containing the value if found

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 111 of file monitorable_interface.h.

                                                               {
        auto it = metrics_.find(key);
        if (it != metrics_.end()) {
            return it->second;
        }
        return std::nullopt;
    }

References metrics_.

Referenced by TEST_F(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

◆ get_metrics()

const metric_map & kcenon::monitoring::monitoring_data::get_metrics ( ) const

inline

Get all metrics.

Returns: Map of all metrics

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 136 of file monitorable_interface.h.

                                          {
        return metrics_;
    }

References metrics_.

Referenced by kcenon::monitoring::opentelemetry_metrics_adapter::convert_monitoring_data(), kcenon::monitoring::prometheus_exporter::convert_monitoring_data(), and kcenon::monitoring::statsd_exporter::convert_monitoring_data().

Here is the caller graph for this function:

◆ get_tag()

std::optional< std::string > kcenon::monitoring::monitoring_data::get_tag ( const std::string & key ) const

inline

Get a tag value.

Parameters

key Tag name

Returns: Optional containing the value if found

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 124 of file monitorable_interface.h.

                                                               {
        auto it = tags_.find(key);
        if (it != tags_.end()) {
            return it->second;
        }
        return std::nullopt;
    }

References tags_.

Referenced by TEST_F(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

◆ get_tags()

const tag_map & kcenon::monitoring::monitoring_data::get_tags ( ) const

inline

Get all tags.

Returns: Map of all tags

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 144 of file monitorable_interface.h.

                                    {
        return tags_;
    }

References tags_.

Referenced by kcenon::monitoring::opentelemetry_metrics_adapter::convert_monitoring_data(), kcenon::monitoring::prometheus_exporter::convert_monitoring_data(), and kcenon::monitoring::statsd_exporter::convert_monitoring_data().

Here is the caller graph for this function:

◆ get_timestamp()

std::chrono::system_clock::time_point kcenon::monitoring::monitoring_data::get_timestamp ( ) const

inline

Get the timestamp.

Returns: Time when the data was collected

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 152 of file monitorable_interface.h.

                                                          {
        return timestamp_;
    }

References timestamp_.

Referenced by kcenon::monitoring::opentelemetry_metrics_adapter::convert_monitoring_data(), kcenon::monitoring::prometheus_exporter::convert_monitoring_data(), and TEST_F().

Here is the caller graph for this function:

◆ merge()

void kcenon::monitoring::monitoring_data::merge	(	const monitoring_data &	other,
		const std::string &	prefix = "" )

inline

Merge another monitoring_data into this one.

Parameters

other	Data to merge
prefix	Optional prefix for merged metrics

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 209 of file monitorable_interface.h.

                                                                           {
        for (const auto& [key, value] : other.metrics_) {
            if (prefix.empty()) {
                metrics_[key] = value;
            } else {
                metrics_[prefix + "." + key] = value;
            }
        }
        
        for (const auto& [key, value] : other.tags_) {
            if (prefix.empty()) {
                tags_[key] = value;
            } else {
                tags_[prefix + "." + key] = value;
            }
        }
    }

References metrics_, kcenon::monitoring::other, and tags_.

Referenced by kcenon::monitoring::monitoring_aggregator::collect_all(), and TEST_F().

Here is the caller graph for this function:

◆ metric_count()

std::size_t kcenon::monitoring::monitoring_data::metric_count ( ) const

inline

Get the number of metrics.

Returns: Count of metrics

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 192 of file monitorable_interface.h.

                                   {
        return metrics_.size();
    }

References metrics_.

Referenced by kcenon::monitoring::monitoring_aggregator::collect_all(), TEST_F(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

◆ set_component_name()

void kcenon::monitoring::monitoring_data::set_component_name ( const std::string & name )

inline

Set the component name.

Parameters

name	Component name

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 168 of file monitorable_interface.h.

                                                   {
        component_name_ = name;
    }

References component_name_.

Referenced by kcenon::monitoring::monitorable_component::reset_monitoring().

Here is the caller graph for this function:

◆ tag_count()

std::size_t kcenon::monitoring::monitoring_data::tag_count ( ) const

inline

Get the number of tags.

Returns: Count of tags

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 200 of file monitorable_interface.h.

                                {
        return tags_.size();
    }

References tags_.

Referenced by TEST_F(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

Member Data Documentation

◆ component_name_

std::string kcenon::monitoring::monitoring_data::component_name_

private

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 71 of file monitorable_interface.h.

Referenced by get_component_name(), and set_component_name().

◆ metrics_

metric_map kcenon::monitoring::monitoring_data::metrics_

private

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 68 of file monitorable_interface.h.

Referenced by add_metric(), clear(), empty(), get_metric(), get_metrics(), merge(), and metric_count().

◆ tags_

tag_map kcenon::monitoring::monitoring_data::tags_

private

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 69 of file monitorable_interface.h.

Referenced by add_tag(), clear(), empty(), get_tag(), get_tags(), merge(), and tag_count().

◆ timestamp_

std::chrono::system_clock::time_point kcenon::monitoring::monitoring_data::timestamp_

private

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 70 of file monitorable_interface.h.

Referenced by get_timestamp().

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

include/kcenon/monitoring/interfaces/monitorable_interface.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ metric_map

◆ tag_map

Constructor & Destructor Documentation

◆ monitoring_data() [1/2]

◆ monitoring_data() [2/2]

Member Function Documentation

◆ add_metric()

◆ add_tag()

◆ clear()

◆ empty()

◆ get_component_name()

◆ get_metric()

◆ get_metrics()

◆ get_tag()

◆ get_tags()

◆ get_timestamp()

◆ merge()

◆ metric_count()

◆ set_component_name()

◆ tag_count()

Member Data Documentation

◆ component_name_

◆ metrics_

◆ tags_

◆ timestamp_