Configuration for metric storage. More...

#include <metric_storage.h>

Collaboration diagram for kcenon::monitoring::metric_storage_config:

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

Public Attributes
size_t	ring_buffer_capacity = 8192

size_t	max_metrics = 10000

bool	enable_background_processing = true

std::chrono::milliseconds	flush_interval {1000}

size_t	time_series_max_points = 3600

std::chrono::seconds	retention_period {3600}

Detailed Description

Configuration for metric storage.

Definition at line 36 of file metric_storage.h.

Member Function Documentation

◆ validate()

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

inline

Validate configuration.

Definition at line 47 of file metric_storage.h.

                                      {
        if (ring_buffer_capacity == 0 || (ring_buffer_capacity & (ring_buffer_capacity - 1)) != 0) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Ring buffer capacity must be a power of 2").to_common_error());
        }
 
        if (max_metrics == 0) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Max metrics must be positive").to_common_error());
        }
 
        if (time_series_max_points == 0) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Time series max points must be positive").to_common_error());
        }
 
        if (retention_period.count() <= 0) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                             "Retention period must be positive").to_common_error());
        }
 
        return common::ok();
    }