Trigger based on comparing value against a threshold. More...

#include <alert_triggers.h>

Inheritance diagram for kcenon::monitoring::threshold_trigger:

Collaboration diagram for kcenon::monitoring::threshold_trigger:

Public Member Functions
	threshold_trigger (double threshold, comparison_operator op=comparison_operator::greater_than, double epsilon=1e-9)
	Construct a threshold trigger.

bool	evaluate (double value) const override
	Evaluate the trigger condition.

std::string	type_name () const override
	Get trigger type name.

std::string	description () const override
	Get human-readable description.

double	threshold () const
	Get the threshold value.

comparison_operator	op () const
	Get the comparison operator.

Public Member Functions inherited from kcenon::monitoring::alert_trigger
virtual	~alert_trigger ()=default

Static Public Member Functions
static std::shared_ptr< threshold_trigger >	above (double threshold)
	Create trigger for value > threshold.

static std::shared_ptr< threshold_trigger >	above_or_equal (double threshold)
	Create trigger for value >= threshold.

static std::shared_ptr< threshold_trigger >	below (double threshold)
	Create trigger for value < threshold.

static std::shared_ptr< threshold_trigger >	below_or_equal (double threshold)
	Create trigger for value <= threshold.

static std::shared_ptr< class range_trigger >	in_range (double min_val, double max_val)
	Create trigger for value within range (inclusive)

static std::shared_ptr< class range_trigger >	out_of_range (double min_val, double max_val)
	Create trigger for value outside range (exclusive)

Private Attributes
double	threshold_

comparison_operator	operator_

double	epsilon_

Detailed Description

Trigger based on comparing value against a threshold.

The most common trigger type, comparing metric values against configured thresholds using various comparison operators.

Definition at line 76 of file alert_triggers.h.

Constructor & Destructor Documentation

◆ threshold_trigger()

kcenon::monitoring::threshold_trigger::threshold_trigger	(	double	threshold,
		comparison_operator	op = comparison_operator::greater_than,
		double	epsilon = 1e-9 )

inlineexplicit

Construct a threshold trigger.

Parameters

threshold	The threshold value
op	Comparison operator
epsilon	Epsilon for floating-point comparison (default 1e-9)

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 84 of file alert_triggers.h.

        : threshold_(threshold)
        , operator_(op)
        , epsilon_(epsilon) {}

Member Function Documentation

◆ above()

static std::shared_ptr< threshold_trigger > kcenon::monitoring::threshold_trigger::above ( double threshold )

inlinestatic

Create trigger for value > threshold.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 133 of file alert_triggers.h.

                                                                    {
        return std::make_shared<threshold_trigger>(threshold, comparison_operator::greater_than);
    }

References kcenon::monitoring::greater_than, and threshold().

Referenced by AlertManagerRuleTest::create_rule(), main(), AlertManagerProcessingTest::SetUp(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ above_or_equal()

static std::shared_ptr< threshold_trigger > kcenon::monitoring::threshold_trigger::above_or_equal ( double threshold )

inlinestatic

Create trigger for value >= threshold.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 140 of file alert_triggers.h.

                                                                             {
        return std::make_shared<threshold_trigger>(threshold, comparison_operator::greater_or_equal);
    }

References kcenon::monitoring::greater_or_equal, and threshold().

Referenced by main(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ below()

static std::shared_ptr< threshold_trigger > kcenon::monitoring::threshold_trigger::below ( double threshold )

inlinestatic

Create trigger for value < threshold.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 147 of file alert_triggers.h.

                                                                    {
        return std::make_shared<threshold_trigger>(threshold, comparison_operator::less_than);
    }

References kcenon::monitoring::less_than, and threshold().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ below_or_equal()

static std::shared_ptr< threshold_trigger > kcenon::monitoring::threshold_trigger::below_or_equal ( double threshold )

inlinestatic

Create trigger for value <= threshold.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 154 of file alert_triggers.h.

                                                                             {
        return std::make_shared<threshold_trigger>(threshold, comparison_operator::less_or_equal);
    }

References kcenon::monitoring::less_or_equal, and threshold().

Referenced by main(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ description()

std::string kcenon::monitoring::threshold_trigger::description ( ) const

inlineoverridevirtual

Get human-readable description.

Returns: Description string

Implements kcenon::monitoring::alert_trigger.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 114 of file alert_triggers.h.

                                           {
        return "value " + std::string(comparison_operator_to_string(operator_)) +
               " " + std::to_string(threshold_);
    }

References kcenon::monitoring::comparison_operator_to_string(), operator_, and threshold_.

Here is the call graph for this function:

◆ evaluate()

bool kcenon::monitoring::threshold_trigger::evaluate ( double value ) const

inlineoverridevirtual

Evaluate the trigger condition.

Parameters

value Current metric value

Returns: True if trigger condition is met

Implements kcenon::monitoring::alert_trigger.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 91 of file alert_triggers.h.

                                               {
        switch (operator_) {
            case comparison_operator::greater_than:
                return value > threshold_;
            case comparison_operator::greater_or_equal:
                return value >= threshold_ - epsilon_;
            case comparison_operator::less_than:
                return value < threshold_;
            case comparison_operator::less_or_equal:
                return value <= threshold_ + epsilon_;
            case comparison_operator::equal:
                return std::abs(value - threshold_) <= epsilon_;
            case comparison_operator::not_equal:
                return std::abs(value - threshold_) > epsilon_;
            default:
                return false;
        }
    }

References epsilon_, kcenon::monitoring::equal, kcenon::monitoring::greater_or_equal, kcenon::monitoring::greater_than, kcenon::monitoring::less_or_equal, kcenon::monitoring::less_than, kcenon::monitoring::not_equal, operator_, and threshold_.

◆ in_range()

std::shared_ptr< range_trigger > kcenon::monitoring::threshold_trigger::in_range	(	double	min_val,
		double	max_val )

inlinestatic

Create trigger for value within range (inclusive)

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 215 of file alert_triggers.h.

                                                                                              {
    return std::make_shared<range_trigger>(min_val, max_val, true);
}

Referenced by main(), and TEST_F().

Here is the caller graph for this function:

◆ op()

comparison_operator kcenon::monitoring::threshold_trigger::op ( ) const

inline

Get the comparison operator.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 127 of file alert_triggers.h.

127{ return operator_; }

References operator_.

◆ out_of_range()

std::shared_ptr< range_trigger > kcenon::monitoring::threshold_trigger::out_of_range	(	double	min_val,
		double	max_val )

inlinestatic

Create trigger for value outside range (exclusive)

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 219 of file alert_triggers.h.

                                                                                                  {
    return std::make_shared<range_trigger>(min_val, max_val, false);
}

Referenced by main(), and TEST_F().

Here is the caller graph for this function:

◆ threshold()

double kcenon::monitoring::threshold_trigger::threshold ( ) const

inline

Get the threshold value.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 122 of file alert_triggers.h.

122{ return threshold_; }

References threshold_.

Referenced by above(), above_or_equal(), below(), and below_or_equal().

Here is the caller graph for this function:

◆ type_name()

std::string kcenon::monitoring::threshold_trigger::type_name ( ) const

inlineoverridevirtual

Get trigger type name.

Returns: Type name string

Implements kcenon::monitoring::alert_trigger.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 110 of file alert_triggers.h.

                                         {
        return "threshold";
    }

Member Data Documentation

◆ epsilon_

double kcenon::monitoring::threshold_trigger::epsilon_

private

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 171 of file alert_triggers.h.

Referenced by evaluate().

◆ operator_

comparison_operator kcenon::monitoring::threshold_trigger::operator_

private

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 170 of file alert_triggers.h.

Referenced by description(), evaluate(), and op().

◆ threshold_

double kcenon::monitoring::threshold_trigger::threshold_

private

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 169 of file alert_triggers.h.

Referenced by description(), evaluate(), and threshold().

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

include/kcenon/monitoring/alert/alert_triggers.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ threshold_trigger()

Member Function Documentation

◆ above()

◆ above_or_equal()

◆ below()

◆ below_or_equal()

◆ description()

◆ evaluate()

◆ in_range()

◆ op()

◆ out_of_range()

◆ threshold()

◆ type_name()

Member Data Documentation

◆ epsilon_

◆ operator_

◆ threshold_