Prometheus metric exporter implementation. More...

#include <metric_exporters.h>

Inheritance diagram for kcenon::monitoring::prometheus_exporter:

Collaboration diagram for kcenon::monitoring::prometheus_exporter:

Public Member Functions
	prometheus_exporter (const metric_export_config &config)

std::vector< prometheus_metric_data >	convert_monitoring_data (const monitoring_data &data) const
	Convert monitoring_data to Prometheus format.

std::vector< prometheus_metric_data >	convert_snapshot (const metrics_snapshot &snapshot) const
	Convert metrics_snapshot to Prometheus format.

common::VoidResult	export_metrics (const std::vector< monitoring_data > &metrics) override
	Export a batch of metrics.

common::VoidResult	export_snapshot (const metrics_snapshot &snapshot) override
	Export a single metrics snapshot.

std::string	get_metrics_text () const
	Get current metrics in Prometheus format (for HTTP endpoint)

common::VoidResult	flush () override
	Flush any pending metrics.

common::VoidResult	shutdown () override
	Shutdown the exporter.

std::unordered_map< std::string, std::size_t >	get_stats () const override
	Get exporter statistics.

Public Member Functions inherited from kcenon::monitoring::metric_exporter_interface
virtual	~metric_exporter_interface ()=default

virtual common::VoidResult	start ()
	Start the exporter (for pull-based systems)

virtual common::VoidResult	stop ()
	Stop the exporter.

Private Member Functions
std::string	sanitize_metric_name (const std::string &name) const

std::string	sanitize_label_name (const std::string &name) const

metric_type	infer_metric_type (const std::string &name, double) const

Private Attributes
metric_export_config	config_

std::atomic< std::size_t >	exported_metrics_ {0}

std::atomic< std::size_t >	failed_exports_ {0}

std::atomic< std::size_t >	scrape_requests_ {0}

std::vector< prometheus_metric_data >	current_metrics_

std::mutex	metrics_mutex_

Detailed Description

Prometheus metric exporter implementation.

Definition at line 286 of file metric_exporters.h.

Constructor & Destructor Documentation

◆ prometheus_exporter()

kcenon::monitoring::prometheus_exporter::prometheus_exporter ( const metric_export_config & config )

inlineexplicit

Definition at line 296 of file metric_exporters.h.

297 : config_(config) {}

kcenon::monitoring::prometheus_exporter::config_

metric_export_config config_

Definition metric_exporters.h:288

Member Function Documentation

◆ convert_monitoring_data()

std::vector< prometheus_metric_data > kcenon::monitoring::prometheus_exporter::convert_monitoring_data ( const monitoring_data & data ) const

inline

Convert monitoring_data to Prometheus format.

Definition at line 302 of file metric_exporters.h.

                                                                                                 {
        std::vector<prometheus_metric_data> prom_metrics;
        
        for (const auto& [name, value] : data.get_metrics()) {
            prometheus_metric_data metric;
            metric.name = sanitize_metric_name(name);
            metric.type = infer_metric_type(name, value);
            metric.value = value;
            metric.timestamp = data.get_timestamp();
            metric.help_text = "Metric from " + data.get_component_name();
            
            // Add component name as label
            metric.labels["component"] = data.get_component_name();
            
            // Add custom labels from config
            for (const auto& [key, label_value] : config_.labels) {
                metric.labels[key] = label_value;
            }
            
            // Add tags as labels
            for (const auto& [key, tag_value] : data.get_tags()) {
                metric.labels[sanitize_label_name(key)] = tag_value;
            }
            
            if (!config_.instance_id.empty()) {
                metric.labels["instance"] = config_.instance_id;
            }
            
            prom_metrics.push_back(std::move(metric));
        }
        
        return prom_metrics;
    }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convert_snapshot()

std::vector< prometheus_metric_data > kcenon::monitoring::prometheus_exporter::convert_snapshot ( const metrics_snapshot & snapshot ) const

inline

Convert metrics_snapshot to Prometheus format.

Definition at line 339 of file metric_exporters.h.

                                                                                               {
        std::vector<prometheus_metric_data> prom_metrics;
        
        for (const auto& metric_val : snapshot.metrics) {
            prometheus_metric_data metric;
            metric.name = sanitize_metric_name(metric_val.name);
            metric.type = infer_metric_type(metric_val.name, metric_val.value);
            metric.value = metric_val.value;
            metric.timestamp = metric_val.timestamp;
            metric.help_text = "System metric";
            
            // Add source as label
            if (!snapshot.source_id.empty()) {
                metric.labels["source"] = snapshot.source_id;
            }
            
            // Add custom labels from config
            for (const auto& [key, label_value] : config_.labels) {
                metric.labels[key] = label_value;
            }
            
            // Add tags as labels
            for (const auto& [key, tag_value] : metric_val.tags) {
                metric.labels[sanitize_label_name(key)] = tag_value;
            }
            
            if (!config_.instance_id.empty()) {
                metric.labels["instance"] = config_.instance_id;
            }
            
            prom_metrics.push_back(std::move(metric));
        }
        
        return prom_metrics;
    }

References config_, infer_metric_type(), kcenon::monitoring::metric_export_config::instance_id, kcenon::monitoring::metric_export_config::labels, kcenon::monitoring::metrics_snapshot::metrics, kcenon::monitoring::metric::name, sanitize_label_name(), sanitize_metric_name(), kcenon::monitoring::metrics_snapshot::source_id, kcenon::monitoring::metric::timestamp, kcenon::monitoring::metric::type, and kcenon::monitoring::metric::value.

Referenced by export_snapshot(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ export_metrics()

common::VoidResult kcenon::monitoring::prometheus_exporter::export_metrics ( const std::vector< monitoring_data > & metrics )

inlineoverridevirtual

Export a batch of metrics.

Implements kcenon::monitoring::metric_exporter_interface.

Definition at line 375 of file metric_exporters.h.

                                                                                        {
        try {
            std::lock_guard<std::mutex> lock(metrics_mutex_);
            current_metrics_.clear();
            
            for (const auto& data : metrics) {
                auto prom_metrics = convert_monitoring_data(data);
                current_metrics_.insert(current_metrics_.end(), 
                                      prom_metrics.begin(), prom_metrics.end());
            }
            
            exported_metrics_ += metrics.size();
            return common::ok();
 
        } catch (const std::exception& e) {
            failed_exports_++;
            return common::VoidResult::err(error_info(monitoring_error_code::operation_failed,
                             "Prometheus export failed: " + std::string(e.what()), "monitoring_system").to_common_error());
        }
    }

References convert_monitoring_data(), current_metrics_, exported_metrics_, failed_exports_, metrics_mutex_, kcenon::monitoring::operation_failed, and kcenon::monitoring::error_info::to_common_error().

Referenced by TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ export_snapshot()

common::VoidResult kcenon::monitoring::prometheus_exporter::export_snapshot ( const metrics_snapshot & snapshot )

inlineoverridevirtual

Export a single metrics snapshot.

Implements kcenon::monitoring::metric_exporter_interface.

Definition at line 396 of file metric_exporters.h.

                                                                                {
        try {
            std::lock_guard<std::mutex> lock(metrics_mutex_);
            auto prom_metrics = convert_snapshot(snapshot);
            current_metrics_.insert(current_metrics_.end(), 
                                  prom_metrics.begin(), prom_metrics.end());
            
            exported_metrics_++;
            return common::ok();
 
        } catch (const std::exception& e) {
            failed_exports_++;
            return common::VoidResult::err(error_info(monitoring_error_code::operation_failed,
                             "Prometheus snapshot export failed: " + std::string(e.what()), "monitoring_system").to_common_error());
        }
    }

References convert_snapshot(), current_metrics_, exported_metrics_, failed_exports_, metrics_mutex_, kcenon::monitoring::operation_failed, and kcenon::monitoring::error_info::to_common_error().

Referenced by TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flush()

common::VoidResult kcenon::monitoring::prometheus_exporter::flush ( )

inlineoverridevirtual

Flush any pending metrics.

Implements kcenon::monitoring::metric_exporter_interface.

Definition at line 430 of file metric_exporters.h.

                                      {
        // Prometheus is pull-based, so flush is a no-op
        return common::ok();
    }

Referenced by shutdown(), and TEST_F().

Here is the caller graph for this function:

◆ get_metrics_text()

std::string kcenon::monitoring::prometheus_exporter::get_metrics_text ( ) const

inline

Get current metrics in Prometheus format (for HTTP endpoint)

Definition at line 416 of file metric_exporters.h.

                                       {
        std::lock_guard<std::mutex> lock(metrics_mutex_);
        std::ostringstream ss;
        
        for (const auto& metric : current_metrics_) {
            ss << metric.to_prometheus_text();
        }
        
        // Increment scrape counter
        const_cast<std::atomic<std::size_t>&>(scrape_requests_)++;
        
        return ss.str();
    }

References current_metrics_, metrics_mutex_, and scrape_requests_.

Referenced by TEST_F().

Here is the caller graph for this function:

◆ get_stats()

std::unordered_map< std::string, std::size_t > kcenon::monitoring::prometheus_exporter::get_stats ( ) const

inlineoverridevirtual

Get exporter statistics.

Implements kcenon::monitoring::metric_exporter_interface.

Definition at line 439 of file metric_exporters.h.

                                                                      {
        return {
            {"exported_metrics", exported_metrics_.load()},
            {"failed_exports", failed_exports_.load()},
            {"scrape_requests", scrape_requests_.load()},
            {"current_metrics_count", current_metrics_.size()}
        };
    }

References current_metrics_, exported_metrics_, failed_exports_, and scrape_requests_.

Referenced by TEST_F(), and TEST_F().

Here is the caller graph for this function:

◆ infer_metric_type()

metric_type kcenon::monitoring::prometheus_exporter::infer_metric_type	(	const std::string &	name,
		double	) const

inlineprivate

Definition at line 477 of file metric_exporters.h.

                                                                         {
        // Simple heuristics for metric type inference
        std::string lower_name = name;
        std::transform(lower_name.begin(), lower_name.end(), lower_name.begin(), ::tolower);
        
        if (lower_name.find("count") != std::string::npos ||
            lower_name.find("total") != std::string::npos ||
            lower_name.find("requests") != std::string::npos) {
            return metric_type::counter;
        } else if (lower_name.find("histogram") != std::string::npos ||
                  lower_name.find("bucket") != std::string::npos) {
            return metric_type::histogram;
        } else if (lower_name.find("summary") != std::string::npos ||
                  lower_name.find("quantile") != std::string::npos) {
            return metric_type::summary;
        } else {
            return metric_type::gauge; // Default to gauge
        }
    }

References kcenon::monitoring::counter, kcenon::monitoring::gauge, kcenon::monitoring::histogram, and kcenon::monitoring::summary.

Referenced by convert_monitoring_data(), and convert_snapshot().

Here is the caller graph for this function:

◆ sanitize_label_name()

std::string kcenon::monitoring::prometheus_exporter::sanitize_label_name ( const std::string & name ) const

inlineprivate

Definition at line 463 of file metric_exporters.h.

                                                               {
        std::string sanitized = name;
        // Replace invalid characters with underscores
        std::regex invalid_chars("[^a-zA-Z0-9_]");
        sanitized = std::regex_replace(sanitized, invalid_chars, "_");
        
        // Ensure it starts with a letter or underscore
        if (!sanitized.empty() && !std::isalpha(sanitized[0]) && sanitized[0] != '_') {
            sanitized = "_" + sanitized;
        }
        
        return sanitized;
    }

Referenced by convert_monitoring_data(), and convert_snapshot().

Here is the caller graph for this function:

◆ sanitize_metric_name()

std::string kcenon::monitoring::prometheus_exporter::sanitize_metric_name ( const std::string & name ) const

inlineprivate

Definition at line 449 of file metric_exporters.h.

                                                                {
        std::string sanitized = name;
        // Replace invalid characters with underscores
        std::regex invalid_chars("[^a-zA-Z0-9_:]");
        sanitized = std::regex_replace(sanitized, invalid_chars, "_");
        
        // Ensure it starts with a letter or underscore
        if (!sanitized.empty() && !std::isalpha(sanitized[0]) && sanitized[0] != '_') {
            sanitized = "_" + sanitized;
        }
        
        return sanitized;
    }

Referenced by convert_monitoring_data(), and convert_snapshot().

Here is the caller graph for this function:

◆ shutdown()

common::VoidResult kcenon::monitoring::prometheus_exporter::shutdown ( )

inlineoverridevirtual

Shutdown the exporter.

Implements kcenon::monitoring::metric_exporter_interface.

Definition at line 435 of file metric_exporters.h.

                                         {
        return flush();
    }

References flush().

Referenced by TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ config_

metric_export_config kcenon::monitoring::prometheus_exporter::config_

private

Definition at line 288 of file metric_exporters.h.

Referenced by convert_monitoring_data(), and convert_snapshot().

◆ current_metrics_

std::vector<prometheus_metric_data> kcenon::monitoring::prometheus_exporter::current_metrics_

private

Definition at line 292 of file metric_exporters.h.

Referenced by export_metrics(), export_snapshot(), get_metrics_text(), and get_stats().

◆ exported_metrics_

std::atomic<std::size_t> kcenon::monitoring::prometheus_exporter::exported_metrics_ {0}

private

Definition at line 289 of file metric_exporters.h.

289{0};

Referenced by export_metrics(), export_snapshot(), and get_stats().

◆ failed_exports_

std::atomic<std::size_t> kcenon::monitoring::prometheus_exporter::failed_exports_ {0}

private

Definition at line 290 of file metric_exporters.h.

290{0};

Referenced by export_metrics(), export_snapshot(), and get_stats().

◆ metrics_mutex_

std::mutex kcenon::monitoring::prometheus_exporter::metrics_mutex_

mutableprivate

Definition at line 293 of file metric_exporters.h.

Referenced by export_metrics(), export_snapshot(), and get_metrics_text().

◆ scrape_requests_

std::atomic<std::size_t> kcenon::monitoring::prometheus_exporter::scrape_requests_ {0}

private

Definition at line 291 of file metric_exporters.h.

291{0};

Referenced by get_metrics_text(), and get_stats().

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

include/kcenon/monitoring/exporters/metric_exporters.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ prometheus_exporter()

Member Function Documentation

◆ convert_monitoring_data()

◆ convert_snapshot()

◆ export_metrics()

◆ export_snapshot()

◆ flush()

◆ get_metrics_text()

◆ get_stats()

◆ infer_metric_type()

◆ sanitize_label_name()

◆ sanitize_metric_name()

◆ shutdown()

Member Data Documentation

◆ config_

◆ current_metrics_

◆ exported_metrics_

◆ failed_exports_

◆ metrics_mutex_

◆ scrape_requests_