kcenon::monitoring::time_series_config Struct Reference

Configuration for time series storage. More...

#include <time_series.h>

Collaboration diagram for kcenon::monitoring::time_series_config:

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

Public Attributes
std::chrono::seconds	retention_period {3600}
std::chrono::milliseconds	resolution {1000}
size_t	max_points = 3600
bool	enable_compression = true
double	compression_threshold = 0.01

Detailed Description

Configuration for time series storage.

Examples

time_series_storage_example.cpp.

Definition at line 34 of file time_series.h.

Member Function Documentation

validate()

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

inline

Validate configuration.

Definition at line 44 of file time_series.h.

                                      {
        if (retention_period.count() <= 0) {
            error_info err(monitoring_error_code::invalid_configuration,
                          "Retention period must be positive");
            return common::VoidResult::err(err.to_common_error());
        }
 
        if (resolution.count() <= 0) {
            error_info err(monitoring_error_code::invalid_configuration,
                          "Resolution must be positive");
            return common::VoidResult::err(err.to_common_error());
        }
 
        if (max_points == 0) {
            error_info err(monitoring_error_code::invalid_configuration,
                          "Max points must be positive");
            return common::VoidResult::err(err.to_common_error());
        }
 
        return common::ok();
    }

References kcenon::monitoring::invalid_configuration, max_points, resolution, retention_period, and kcenon::monitoring::error_info::to_common_error().

Referenced by TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

compression_threshold

double kcenon::monitoring::time_series_config::compression_threshold = 0.01

Examples

time_series_storage_example.cpp.

Definition at line 39 of file time_series.h.

Referenced by kcenon::monitoring::time_series::compress_data(), and demonstrate_basic_operations().

enable_compression

bool kcenon::monitoring::time_series_config::enable_compression = true

Examples

time_series_storage_example.cpp.

Definition at line 38 of file time_series.h.

Referenced by kcenon::monitoring::time_series::compress_data(), demonstrate_basic_operations(), and demonstrate_retention_and_downsampling().

max_points

size_t kcenon::monitoring::time_series_config::max_points = 3600

Examples

time_series_storage_example.cpp.

Definition at line 37 of file time_series.h.

Referenced by demonstrate_aggregations(), demonstrate_basic_operations(), demonstrate_retention_and_downsampling(), kcenon::monitoring::time_series::enforce_size_limit(), kcenon::monitoring::metric_storage::get_or_create_series(), TEST_F(), kcenon::monitoring::time_series::time_series(), and validate().

resolution

std::chrono::milliseconds kcenon::monitoring::time_series_config::resolution {1000}

Examples

time_series_storage_example.cpp.

Definition at line 36 of file time_series.h.

{1000};       // Time resolution for aggregation

Referenced by demonstrate_basic_operations(), and validate().

retention_period

std::chrono::seconds kcenon::monitoring::time_series_config::retention_period {3600}

Examples

time_series_storage_example.cpp.

Definition at line 35 of file time_series.h.

{3600};      // How long to keep data

Referenced by kcenon::monitoring::time_series::cleanup_old_data(), demonstrate_aggregations(), demonstrate_basic_operations(), demonstrate_retention_and_downsampling(), kcenon::monitoring::metric_storage::get_or_create_series(), TEST_F(), TEST_F(), and validate().

---

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

• include/kcenon/monitoring/utils/time_series.h