kcenon::monitoring::otlp_grpc_config Struct Reference

Configuration for OTLP gRPC exporter. More...

#include <otlp_grpc_exporter.h>

Collaboration diagram for kcenon::monitoring::otlp_grpc_config:

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

Public Attributes
std::string	endpoint = "localhost:4317"
	OTLP receiver endpoint.
std::chrono::milliseconds	timeout {10000}
	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.
std::size_t	max_retry_attempts = 3
	Maximum retry attempts.
std::chrono::milliseconds	initial_backoff {100}
	Initial retry backoff.
std::chrono::milliseconds	max_backoff {10000}
	Maximum retry backoff.
bool	use_tls = false
	Enable TLS.
std::string	certificate_path
	TLS certificate path.
std::string	service_name = "monitoring_system"
	Service name.
std::string	service_version = "2.0.0"
	Service version.
std::unordered_map< std::string, std::string >	headers
	Custom headers.
std::unordered_map< std::string, std::string >	resource_attributes
	Resource attributes.

Detailed Description

Configuration for OTLP gRPC exporter.

Examples

otlp_export_example.cpp.

Definition at line 41 of file otlp_grpc_exporter.h.

Member Function Documentation

validate()

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

inline

Validate configuration.

Definition at line 60 of file otlp_grpc_exporter.h.

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

References endpoint, kcenon::monitoring::invalid_configuration, max_batch_size, and timeout.

Referenced by kcenon::monitoring::otlp_grpc_exporter::start(), and TEST_F().

Here is the caller graph for this function:

Member Data Documentation

batch_timeout

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

Batch export timeout.

Examples

otlp_export_example.cpp.

Definition at line 44 of file otlp_grpc_exporter.h.

{5000};   

Referenced by create_otlp_config().

certificate_path

std::string kcenon::monitoring::otlp_grpc_config::certificate_path

TLS certificate path.

Definition at line 51 of file otlp_grpc_exporter.h.

endpoint

std::string kcenon::monitoring::otlp_grpc_config::endpoint = "localhost:4317"

OTLP receiver endpoint.

Examples

otlp_export_example.cpp.

Definition at line 42 of file otlp_grpc_exporter.h.

Referenced by create_otlp_config(), kcenon::monitoring::create_otlp_grpc_exporter(), kcenon::monitoring::otlp_grpc_exporter::start(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and validate().

headers

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

Custom headers.

Examples

otlp_export_example.cpp.

Definition at line 54 of file otlp_grpc_exporter.h.

Referenced by create_otlp_config(), and kcenon::monitoring::otlp_grpc_exporter::export_spans().

initial_backoff

std::chrono::milliseconds kcenon::monitoring::otlp_grpc_config::initial_backoff {100}

Initial retry backoff.

Examples

otlp_export_example.cpp.

Definition at line 48 of file otlp_grpc_exporter.h.

{100};  

Referenced by create_otlp_config(), kcenon::monitoring::otlp_grpc_exporter::send_with_retry(), and TEST_F().

max_backoff

std::chrono::milliseconds kcenon::monitoring::otlp_grpc_config::max_backoff {10000}

Maximum retry backoff.

Examples

otlp_export_example.cpp.

Definition at line 49 of file otlp_grpc_exporter.h.

{10000};    

Referenced by create_otlp_config(), and kcenon::monitoring::otlp_grpc_exporter::send_with_retry().

max_batch_size

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

Maximum spans per batch.

Examples

otlp_export_example.cpp.

Definition at line 45 of file otlp_grpc_exporter.h.

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

max_queue_size

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

Maximum queued spans.

Examples

otlp_export_example.cpp.

Definition at line 46 of file otlp_grpc_exporter.h.

Referenced by create_otlp_config().

max_retry_attempts

std::size_t kcenon::monitoring::otlp_grpc_config::max_retry_attempts = 3

Maximum retry attempts.

Examples

otlp_export_example.cpp.

Definition at line 47 of file otlp_grpc_exporter.h.

Referenced by create_otlp_config(), kcenon::monitoring::otlp_grpc_exporter::send_with_retry(), and TEST_F().

resource_attributes

std::unordered_map<std::string, std::string> kcenon::monitoring::otlp_grpc_config::resource_attributes

Resource attributes.

Examples

otlp_export_example.cpp.

Definition at line 55 of file otlp_grpc_exporter.h.

Referenced by create_otlp_config(), and kcenon::monitoring::otlp_grpc_exporter::export_spans().

service_name

std::string kcenon::monitoring::otlp_grpc_config::service_name = "monitoring_system"

Service name.

Examples

otlp_export_example.cpp.

Definition at line 52 of file otlp_grpc_exporter.h.

Referenced by create_otlp_config(), kcenon::monitoring::otlp_grpc_exporter::export_spans(), TEST_F(), and TEST_F().

service_version

std::string kcenon::monitoring::otlp_grpc_config::service_version = "2.0.0"

Service version.

Examples

otlp_export_example.cpp.

Definition at line 53 of file otlp_grpc_exporter.h.

Referenced by create_otlp_config(), kcenon::monitoring::otlp_grpc_exporter::export_spans(), and TEST_F().

timeout

std::chrono::milliseconds kcenon::monitoring::otlp_grpc_config::timeout {10000}

Request timeout.

Examples

otlp_export_example.cpp.

Definition at line 43 of file otlp_grpc_exporter.h.

{10000};        

Referenced by create_otlp_config(), kcenon::monitoring::otlp_grpc_exporter::export_spans(), TEST_F(), and validate().

use_tls

bool kcenon::monitoring::otlp_grpc_config::use_tls = false

Enable TLS.

Examples

otlp_export_example.cpp.

Definition at line 50 of file otlp_grpc_exporter.h.

Referenced by create_otlp_config(), and TEST_F().

---

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

• include/kcenon/monitoring/exporters/otlp_grpc_exporter.h