Configuration for metric exporters. More...

#include <metric_exporters.h>

Collaboration diagram for kcenon::monitoring::metric_export_config:

Public Member Functions
common::VoidResult	validate () const
	Validate export configuration.

Public Attributes
std::string	endpoint
	Endpoint URL or address.

std::uint16_t	port = 0
	Port number (for UDP/TCP)

metric_export_format	format = metric_export_format::prometheus_text

std::chrono::milliseconds	push_interval {15000}
	Push interval for push-based systems.

std::chrono::milliseconds	timeout {5000}
	Request timeout.

std::size_t	max_batch_size = 1000
	Maximum metrics per batch.

std::size_t	max_queue_size = 10000
	Maximum queued metrics.

bool	enable_compression = false
	Enable data compression.

std::unordered_map< std::string, std::string >	headers
	Custom HTTP headers.

std::unordered_map< std::string, std::string >	labels
	Default labels/tags.

std::string	job_name = "monitoring_system"
	Prometheus job name.

std::string	instance_id
	Instance identifier.

Detailed Description

Configuration for metric exporters.

Definition at line 76 of file metric_exporters.h.

Member Function Documentation

◆ validate()

common::VoidResult kcenon::monitoring::metric_export_config::validate ( ) const

inline

Validate export configuration.

Definition at line 93 of file metric_exporters.h.

                                      {
        if (endpoint.empty() && port == 0) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Either endpoint or port must be specified", "monitoring_system").to_common_error());
        }
 
        if (push_interval.count() <= 0) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Push interval must be positive", "monitoring_system").to_common_error());
        }
 
        if (max_batch_size == 0) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Batch size must be greater than 0", "monitoring_system").to_common_error());
        }
 
        if (max_queue_size < max_batch_size) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Queue size must be at least batch size", "monitoring_system").to_common_error());
        }
 
        return common::ok();
    }

References endpoint, kcenon::monitoring::invalid_configuration, max_batch_size, max_queue_size, port, and push_interval.

Referenced by TEST_F().

Here is the caller graph for this function:

Member Data Documentation

◆ enable_compression

bool kcenon::monitoring::metric_export_config::enable_compression = false

Enable data compression.

Definition at line 84 of file metric_exporters.h.

◆ endpoint

std::string kcenon::monitoring::metric_export_config::endpoint

Endpoint URL or address.

Definition at line 77 of file metric_exporters.h.

Referenced by kcenon::monitoring::create_otlp_metrics_exporter(), kcenon::monitoring::create_statsd_exporter(), kcenon::monitoring::statsd_exporter::send_udp_batch(), kcenon::monitoring::otlp_metrics_exporter::send_via_grpc(), kcenon::monitoring::otlp_metrics_exporter::send_via_http(), kcenon::monitoring::statsd_exporter::start(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and validate().

◆ format

metric_export_format kcenon::monitoring::metric_export_config::format = metric_export_format::prometheus_text

◆ headers

std::unordered_map<std::string, std::string> kcenon::monitoring::metric_export_config::headers

Custom HTTP headers.

Definition at line 85 of file metric_exporters.h.

Referenced by kcenon::monitoring::otlp_metrics_exporter::send_via_http().

◆ instance_id

std::string kcenon::monitoring::metric_export_config::instance_id

Instance identifier.

Definition at line 88 of file metric_exporters.h.

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

◆ job_name

std::string kcenon::monitoring::metric_export_config::job_name = "monitoring_system"

Prometheus job name.

Definition at line 87 of file metric_exporters.h.

Referenced by kcenon::monitoring::create_prometheus_exporter().

◆ labels

std::unordered_map<std::string, std::string> kcenon::monitoring::metric_export_config::labels

Default labels/tags.

Definition at line 86 of file metric_exporters.h.

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

◆ max_batch_size

std::size_t kcenon::monitoring::metric_export_config::max_batch_size = 1000

Maximum metrics per batch.

Definition at line 82 of file metric_exporters.h.

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

◆ max_queue_size

std::size_t kcenon::monitoring::metric_export_config::max_queue_size = 10000

Maximum queued metrics.

Definition at line 83 of file metric_exporters.h.

Referenced by TEST_F(), and validate().

◆ port

std::uint16_t kcenon::monitoring::metric_export_config::port = 0

Port number (for UDP/TCP)

Definition at line 78 of file metric_exporters.h.

Referenced by kcenon::monitoring::create_prometheus_exporter(), kcenon::monitoring::create_statsd_exporter(), kcenon::monitoring::statsd_exporter::send_udp_batch(), kcenon::monitoring::otlp_metrics_exporter::send_via_grpc(), kcenon::monitoring::otlp_metrics_exporter::send_via_http(), kcenon::monitoring::statsd_exporter::start(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and validate().

◆ push_interval

std::chrono::milliseconds kcenon::monitoring::metric_export_config::push_interval {15000}

Push interval for push-based systems.

Definition at line 80 of file metric_exporters.h.

80{15000};

Referenced by TEST_F(), and validate().

◆ timeout

std::chrono::milliseconds kcenon::monitoring::metric_export_config::timeout {5000}

Request timeout.

Definition at line 81 of file metric_exporters.h.

81{5000};

Referenced by kcenon::monitoring::otlp_metrics_exporter::send_via_grpc(), and kcenon::monitoring::otlp_metrics_exporter::send_via_http().

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

include/kcenon/monitoring/exporters/metric_exporters.h

Public Member Functions

Public Attributes