Complete snapshot of metrics at a point in time. More...

#include <monitoring_core.h>

Collaboration diagram for kcenon::monitoring::metrics_snapshot:

Public Member Functions
	metrics_snapshot ()

void	add_metric (const std::string &name, double value)
	Add a metric to the snapshot.

void	add_metric (const std::string &name, double value, const std::unordered_map< std::string, std::string > &tags)
	Add a metric to the snapshot with tags.

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

Public Attributes
std::vector< metric_value >	metrics

std::chrono::system_clock::time_point	capture_time

std::string	source_id

Detailed Description

Complete snapshot of metrics at a point in time.

Examples: bidirectional_di_example.cpp, monitor_factory_pattern_example.cpp, and result_pattern_example.cpp.

Definition at line 64 of file monitoring_core.h.

Constructor & Destructor Documentation

◆ metrics_snapshot()

kcenon::monitoring::metrics_snapshot::metrics_snapshot ( )

inline

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

Definition at line 69 of file monitoring_core.h.

70 : capture_time(std::chrono::system_clock::now()) {}

kcenon::monitoring::metrics_snapshot::capture_time

std::chrono::system_clock::time_point capture_time

Definition monitoring_core.h:66

Member Function Documentation

◆ add_metric() [1/2]

void kcenon::monitoring::metrics_snapshot::add_metric	(	const std::string &	name,
		double	value )

inline

Add a metric to the snapshot.

Parameters

name	Metric name
value	Metric value

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitoring_core.h, bidirectional_di_example.cpp, and result_pattern_example.cpp.

Definition at line 77 of file monitoring_core.h.

                                                         {
        metrics.emplace_back(name, value);
    }

References metrics.

Referenced by mock_collector::collect(), MetricExportersTest::create_test_snapshot(), StorageBackendsTest::create_test_snapshots(), console_logger::get_monitoring_data(), main(), TEST(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

◆ add_metric() [2/2]

void kcenon::monitoring::metrics_snapshot::add_metric	(	const std::string &	name,
		double	value,
		const std::unordered_map< std::string, std::string > &	tags )

inline

Add a metric to the snapshot with tags.

Parameters

name	Metric name
value	Metric value
tags	Metadata tags for the metric

Definition at line 87 of file monitoring_core.h.

                                                                       {
        metric_value mv(name, value);
        mv.tags = tags;
        metrics.push_back(std::move(mv));
    }

References metrics, and kcenon::monitoring::metric_value::tags.

◆ get_metric()

std::optional< double > kcenon::monitoring::metrics_snapshot::get_metric ( const std::string & name ) const

inline

Get a specific metric value.

Parameters

name	Metric name

Returns: Optional metric value

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitoring_core.h, and result_pattern_example.cpp.

Definition at line 99 of file monitoring_core.h.

                                                                {
        for (const auto& m : metrics) {
            if (m.name == name) {
                return m.value;
            }
        }
        return std::nullopt;
    }