sample_monitoring Class Reference

Inheritance diagram for sample_monitoring:

Collaboration diagram for sample_monitoring:

Public Types
using	VoidResult = kcenon::common::VoidResult

Public Member Functions
VoidResult	record_metric (const std::string &name, double value) override
VoidResult	record_metric (const std::string &name, double value, const std::unordered_map< std::string, std::string > &tags) override
kcenon::common::Result< kcenon::common::interfaces::metrics_snapshot >	get_metrics () override
kcenon::common::Result< kcenon::common::interfaces::health_check_result >	check_health () override
VoidResult	reset () override

Private Attributes
kcenon::common::interfaces::metrics_snapshot	snapshot_

Detailed Description

Examples

multi_process_monitoring_integration.cpp.

Definition at line 37 of file multi_process_monitoring_integration.cpp.

Member Typedef Documentation

VoidResult

using sample_monitoring::VoidResult = kcenon::common::VoidResult

Examples

multi_process_monitoring_integration.cpp.

Definition at line 39 of file multi_process_monitoring_integration.cpp.

Member Function Documentation

check_health()

kcenon::common::Result< kcenon::common::interfaces::health_check_result > sample_monitoring::check_health ( )

inlineoverride

Examples

multi_process_monitoring_integration.cpp.

Definition at line 74 of file multi_process_monitoring_integration.cpp.

                                                                                          {
        kcenon::common::interfaces::health_check_result result;
        result.status = kcenon::common::interfaces::health_status::healthy;
        result.message = "Sample monitoring active";
        return kcenon::common::ok(result);
    }

get_metrics()

kcenon::common::Result< kcenon::common::interfaces::metrics_snapshot > sample_monitoring::get_metrics ( )

inlineoverride

Examples

multi_process_monitoring_integration.cpp.

Definition at line 70 of file multi_process_monitoring_integration.cpp.

                                                                                      {
        return kcenon::common::ok(snapshot_);
    }

References snapshot_.

record_metric() [1/2]

VoidResult sample_monitoring::record_metric ( const std::string & name, double value )

inlineoverride

Examples

multi_process_monitoring_integration.cpp.

Definition at line 41 of file multi_process_monitoring_integration.cpp.

                                                                           {
        std::cout << formatter::format("{}: {}\n", name, value);
        snapshot_.add_metric(name, value);
        return kcenon::common::ok();
    }

References snapshot_.

record_metric() [2/2]

VoidResult sample_monitoring::record_metric ( const std::string & name, double value, const std::unordered_map< std::string, std::string > & tags )

inlineoverride

Definition at line 47 of file multi_process_monitoring_integration.cpp.

                                                                     {
        std::cout << formatter::format("{}: {}", name, value);
        if (!tags.empty()) {
            std::cout << " [";
            bool first = true;
            for (const auto& [k, v] : tags) {
                if (!first) std::cout << ", ";
                std::cout << k << "=" << v;
                first = false;
            }
            std::cout << "]";
        }
        std::cout << "\n";
 
        kcenon::common::interfaces::metric_value mv(name, value);
        mv.tags = tags;
        snapshot_.metrics.push_back(mv);
        return kcenon::common::ok();
    }

References snapshot_.

reset()

VoidResult sample_monitoring::reset ( )

inlineoverride

Examples

multi_process_monitoring_integration.cpp.

Definition at line 81 of file multi_process_monitoring_integration.cpp.

                                {
        snapshot_ = {};
        return kcenon::common::ok();
    }

References snapshot_.

Member Data Documentation

snapshot_

kcenon::common::interfaces::metrics_snapshot sample_monitoring::snapshot_

private

Examples

multi_process_monitoring_integration.cpp.

Definition at line 87 of file multi_process_monitoring_integration.cpp.

Referenced by get_metrics(), record_metric(), record_metric(), and reset().

---

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

• examples/multi_process_monitoring_integration/multi_process_monitoring_integration.cpp