Configuration for trace exporters. More...

#include <trace_exporters.h>

Collaboration diagram for kcenon::monitoring::trace_export_config:

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

Public Attributes
std::string	endpoint
	Endpoint URL.

trace_export_format	format = trace_export_format::otlp_grpc

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

std::chrono::milliseconds	batch_timeout {5000}
	Batch export timeout.

std::size_t	max_batch_size = 512
	Maximum spans per batch.

std::size_t	max_queue_size = 2048
	Maximum queued spans.

bool	enable_compression = true
	Enable data compression.

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

std::optional< std::string >	service_name
	Override service name.

Detailed Description

Configuration for trace exporters.

Definition at line 61 of file trace_exporters.h.

Member Function Documentation

◆ validate()

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

inline

Validate export configuration.

Definition at line 75 of file trace_exporters.h.

                                      {
        if (endpoint.empty()) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Export endpoint cannot be empty", "monitoring_system").to_common_error());
        }
 
        if (timeout.count() <= 0) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Timeout 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, and timeout.

Referenced by TEST_F().

Here is the caller graph for this function:

Member Data Documentation

◆ batch_timeout

std::chrono::milliseconds kcenon::monitoring::trace_export_config::batch_timeout {5000}

Batch export timeout.

Definition at line 65 of file trace_exporters.h.

65{5000};

◆ enable_compression

bool kcenon::monitoring::trace_export_config::enable_compression = true

Enable data compression.

Definition at line 68 of file trace_exporters.h.

◆ endpoint

std::string kcenon::monitoring::trace_export_config::endpoint

◆ format

trace_export_format kcenon::monitoring::trace_export_config::format = trace_export_format::otlp_grpc

Definition at line 63 of file trace_exporters.h.

Referenced by kcenon::monitoring::trace_exporter_factory::create_exporter(), kcenon::monitoring::create_jaeger_exporter(), kcenon::monitoring::create_otlp_exporter(), kcenon::monitoring::create_zipkin_exporter(), kcenon::monitoring::jaeger_exporter::export_spans(), kcenon::monitoring::otlp_exporter::export_spans(), kcenon::monitoring::zipkin_exporter::export_spans(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ headers

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

Custom HTTP headers.

Definition at line 69 of file trace_exporters.h.

Referenced by kcenon::monitoring::jaeger_exporter::send_grpc_batch(), kcenon::monitoring::zipkin_exporter::send_json_batch(), kcenon::monitoring::zipkin_exporter::send_protobuf_batch(), and kcenon::monitoring::jaeger_exporter::send_thrift_batch().

◆ max_batch_size

std::size_t kcenon::monitoring::trace_export_config::max_batch_size = 512

Maximum spans per batch.

Definition at line 66 of file trace_exporters.h.

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

◆ max_queue_size

std::size_t kcenon::monitoring::trace_export_config::max_queue_size = 2048

Maximum queued spans.

Definition at line 67 of file trace_exporters.h.

Referenced by TEST_F(), and validate().

◆ service_name

std::optional<std::string> kcenon::monitoring::trace_export_config::service_name

Override service name.

Definition at line 70 of file trace_exporters.h.

Referenced by kcenon::monitoring::jaeger_exporter::convert_span(), kcenon::monitoring::zipkin_exporter::convert_span(), TEST_F(), and TEST_F().

◆ timeout

std::chrono::milliseconds kcenon::monitoring::trace_export_config::timeout {30000}

Request timeout.

Definition at line 64 of file trace_exporters.h.

64{30000};

Referenced by kcenon::monitoring::jaeger_exporter::send_grpc_batch(), kcenon::monitoring::zipkin_exporter::send_json_batch(), kcenon::monitoring::zipkin_exporter::send_protobuf_batch(), kcenon::monitoring::jaeger_exporter::send_thrift_batch(), TEST_F(), and validate().

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

include/kcenon/monitoring/exporters/trace_exporters.h

Public Member Functions

Public Attributes