kcenon::monitoring::aggregation_rule Struct Reference

Configuration for metric aggregation. More...

#include <aggregation_processor.h>

Collaboration diagram for kcenon::monitoring::aggregation_rule:

Public Member Functions
common::VoidResult	validate () const
	Validate the aggregation rule.

Public Attributes
std::string	source_metric
	Source metric name.
std::string	target_metric_prefix
	Prefix for aggregated metrics.
std::chrono::milliseconds	aggregation_interval {60000}
	Aggregation interval.
std::vector< double >	percentiles = {0.5, 0.9, 0.95, 0.99}
	Percentiles to compute.
bool	compute_rate = false
	Compute rate of change.
bool	detect_outliers = true
	Enable outlier detection.
double	outlier_threshold = 3.0
	Outlier detection threshold.

Detailed Description

Configuration for metric aggregation.

Definition at line 35 of file aggregation_processor.h.

Member Function Documentation

validate()

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

inline

Validate the aggregation rule.

Definition at line 47 of file aggregation_processor.h.

                                      {
        if (source_metric.empty()) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                                   "Source metric name cannot be empty").to_common_error());
        }
        if (target_metric_prefix.empty()) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                                   "Target metric prefix cannot be empty").to_common_error());
        }
        if (aggregation_interval.count() <= 0) {
            return common::VoidResult::err(error_info(monitoring_error_code::invalid_configuration,
                                   "Aggregation interval must be positive").to_common_error());
        }
        return common::ok();
    }

References aggregation_interval, kcenon::monitoring::invalid_configuration, source_metric, and target_metric_prefix.

Referenced by kcenon::monitoring::aggregation_processor::add_aggregation_rule(), and TEST_F().

Here is the caller graph for this function:

Member Data Documentation

aggregation_interval

std::chrono::milliseconds kcenon::monitoring::aggregation_rule::aggregation_interval {60000}

Aggregation interval.

Definition at line 38 of file aggregation_processor.h.

{60000};      

Referenced by kcenon::monitoring::create_standard_aggregation_rules(), TEST_F(), TEST_F(), TEST_F(), and validate().

compute_rate

bool kcenon::monitoring::aggregation_rule::compute_rate = false

Compute rate of change.

Definition at line 40 of file aggregation_processor.h.

Referenced by kcenon::monitoring::create_standard_aggregation_rules(), and TEST_F().

detect_outliers

bool kcenon::monitoring::aggregation_rule::detect_outliers = true

Enable outlier detection.

Definition at line 41 of file aggregation_processor.h.

Referenced by kcenon::monitoring::aggregation_processor::add_aggregation_rule(), kcenon::monitoring::create_standard_aggregation_rules(), and TEST_F().

outlier_threshold

double kcenon::monitoring::aggregation_rule::outlier_threshold = 3.0

Outlier detection threshold.

Definition at line 42 of file aggregation_processor.h.

Referenced by kcenon::monitoring::aggregation_processor::add_aggregation_rule(), and kcenon::monitoring::create_standard_aggregation_rules().

percentiles

std::vector<double> kcenon::monitoring::aggregation_rule::percentiles = {0.5, 0.9, 0.95, 0.99}

Percentiles to compute.

Definition at line 39 of file aggregation_processor.h.

{0.5, 0.9, 0.95, 0.99};   

Referenced by kcenon::monitoring::aggregation_processor::add_aggregation_rule(), kcenon::monitoring::create_standard_aggregation_rules(), TEST_F(), and TEST_F().

source_metric

std::string kcenon::monitoring::aggregation_rule::source_metric

Source metric name.

Definition at line 36 of file aggregation_processor.h.

Referenced by kcenon::monitoring::aggregation_processor::add_aggregation_rule(), kcenon::monitoring::create_standard_aggregation_rules(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and validate().

target_metric_prefix

std::string kcenon::monitoring::aggregation_rule::target_metric_prefix

Prefix for aggregated metrics.

Definition at line 37 of file aggregation_processor.h.

Referenced by kcenon::monitoring::create_standard_aggregation_rules(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and validate().

---

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

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