kcenon::monitoring::alert_inhibitor Class Reference

Manages alert inhibition rules. More...

#include <alert_pipeline.h>

Collaboration diagram for kcenon::monitoring::alert_inhibitor:

Public Member Functions
void	add_rule (const inhibition_rule &rule)
	Add an inhibition rule.
void	remove_rule (const std::string &name)
	Remove an inhibition rule by name.
bool	is_inhibited (const alert &target, const std::vector< alert > &active_alerts) const
	Check if an alert is inhibited by any active alerts.
std::vector< inhibition_rule >	get_rules () const
	Get all rules.

Private Attributes
std::mutex	mutex_
std::vector< inhibition_rule >	rules_

Detailed Description

Manages alert inhibition rules.

Alert inhibition prevents certain alerts from triggering when related, more important alerts are already firing.

Examples

alert_pipeline_example.cpp.

Definition at line 330 of file alert_pipeline.h.

Member Function Documentation

add_rule()

void kcenon::monitoring::alert_inhibitor::add_rule ( const inhibition_rule & rule )

inline

Add an inhibition rule.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_pipeline.h, and alert_pipeline_example.cpp.

Definition at line 335 of file alert_pipeline.h.

                                               {
        std::lock_guard<std::mutex> lock(mutex_);
        rules_.push_back(rule);
    }

References mutex_, and rules_.

Referenced by main().

Here is the caller graph for this function:

get_rules()

std::vector< inhibition_rule > kcenon::monitoring::alert_inhibitor::get_rules ( ) const

inline

Get all rules.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_pipeline.h.

Definition at line 386 of file alert_pipeline.h.

                                                 {
        std::lock_guard<std::mutex> lock(mutex_);
        return rules_;
    }

References mutex_, and rules_.

is_inhibited()

bool kcenon::monitoring::alert_inhibitor::is_inhibited ( const alert & target, const std::vector< alert > & active_alerts ) const

inline

Check if an alert is inhibited by any active alerts.

Parameters

target	Alert to check
active_alerts	Currently firing alerts

Returns

True if alert should be inhibited

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_pipeline.h, and alert_pipeline_example.cpp.

Definition at line 358 of file alert_pipeline.h.

                                                                   {
        std::lock_guard<std::mutex> lock(mutex_);
 
        for (const auto& rule : rules_) {
            for (const auto& source : active_alerts) {
                // Source must be firing
                if (source.state != alert_state::firing) {
                    continue;
                }
 
                // Don't inhibit self
                if (source.fingerprint() == target.fingerprint()) {
                    continue;
                }
 
                if (rule.should_inhibit(source, target)) {
                    return true;
                }
            }
        }
 
        return false;
    }

References kcenon::monitoring::alert::fingerprint(), kcenon::monitoring::firing, mutex_, and rules_.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

remove_rule()

void kcenon::monitoring::alert_inhibitor::remove_rule ( const std::string & name )

inline

Remove an inhibition rule by name.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_pipeline.h.

Definition at line 343 of file alert_pipeline.h.

                                            {
        std::lock_guard<std::mutex> lock(mutex_);
        rules_.erase(
            std::remove_if(rules_.begin(), rules_.end(),
                [&name](const inhibition_rule& r) { return r.name == name; }),
            rules_.end()
        );
    }

References mutex_, and rules_.

Member Data Documentation

mutex_

std::mutex kcenon::monitoring::alert_inhibitor::mutex_

mutableprivate

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_pipeline.h.

Definition at line 392 of file alert_pipeline.h.

Referenced by add_rule(), get_rules(), is_inhibited(), and remove_rule().

rules_

std::vector<inhibition_rule> kcenon::monitoring::alert_inhibitor::rules_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_pipeline.h.

Definition at line 393 of file alert_pipeline.h.

Referenced by add_rule(), get_rules(), is_inhibited(), and remove_rule().

---

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

• include/kcenon/monitoring/alert/alert_pipeline.h