Routes alerts to different notifiers based on criteria. More...

#include <alert_notifiers.h>

Inheritance diagram for kcenon::monitoring::routing_notifier:

Collaboration diagram for kcenon::monitoring::routing_notifier:

Classes
struct	route

Public Types
using	route_condition = std::function<bool(const alert&)>

Public Member Functions
	routing_notifier (std::string notifier_name)
	Construct routing notifier.

void	add_route (route_condition condition, std::shared_ptr< alert_notifier > notifier)
	Add a route.

void	set_default_route (std::shared_ptr< alert_notifier > notifier)
	Add a default route for non-matching alerts.

std::string	name () const override
	Get notifier name.

common::VoidResult	notify (const alert &a) override
	Send a notification for an alert.

common::VoidResult	notify_group (const alert_group &group) override
	Send a notification for an alert group.

bool	is_ready () const override
	Check if notifier is ready.

void	route_by_severity (alert_severity severity, std::shared_ptr< alert_notifier > notifier)
	Route by severity.

void	route_by_label (const std::string &key, const std::string &value, std::shared_ptr< alert_notifier > notifier)
	Route by label.

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

Private Attributes
std::string	name_

std::mutex	mutex_

std::vector< route >	routes_

std::shared_ptr< alert_notifier >	default_route_

Detailed Description

Routes alerts to different notifiers based on criteria.

Allows configuring different notification targets based on alert properties like severity or labels.

Definition at line 559 of file alert_notifiers.h.

Member Typedef Documentation

◆ route_condition

using kcenon::monitoring::routing_notifier::route_condition = std::function<bool(const alert&)>

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

Definition at line 561 of file alert_notifiers.h.

Constructor & Destructor Documentation

◆ routing_notifier()

kcenon::monitoring::routing_notifier::routing_notifier ( std::string notifier_name )

inlineexplicit

Construct routing notifier.

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

Definition at line 566 of file alert_notifiers.h.

567 : name_(std::move(notifier_name)) {}

kcenon::monitoring::routing_notifier::name_

std::string name_

Definition alert_notifiers.h:652

Member Function Documentation

◆ add_route()

void kcenon::monitoring::routing_notifier::add_route	(	route_condition	condition,
		std::shared_ptr< alert_notifier >	notifier )

inline

Add a route.

Parameters

condition	Condition for this route
notifier	Notifier to use when condition matches

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

Definition at line 574 of file alert_notifiers.h.

                                                           {
        std::lock_guard<std::mutex> lock(mutex_);
        routes_.push_back({std::move(condition), std::move(notifier)});
    }

References mutex_, and routes_.

Referenced by route_by_label(), and route_by_severity().

Here is the caller graph for this function:

◆ is_ready()

bool kcenon::monitoring::routing_notifier::is_ready ( ) const

inlineoverridevirtual

Check if notifier is ready.

Returns: True if ready to send notifications

Implements kcenon::monitoring::alert_notifier.

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

Definition at line 617 of file alert_notifiers.h.

                                   {
        std::lock_guard<std::mutex> lock(mutex_);
        return !routes_.empty() || default_route_ != nullptr;
    }

References default_route_, mutex_, and routes_.

◆ name()

std::string kcenon::monitoring::routing_notifier::name ( ) const

inlineoverridevirtual

Get notifier name.

Returns: Notifier name

Implements kcenon::monitoring::alert_notifier.

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

Definition at line 588 of file alert_notifiers.h.

588{ return name_; }

References name_.

◆ notify()

common::VoidResult kcenon::monitoring::routing_notifier::notify ( const alert & a )

inlineoverridevirtual

Send a notification for an alert.

Parameters

a	Alert to notify about

Returns: Result indicating success or failure

Implements kcenon::monitoring::alert_notifier.

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

Definition at line 590 of file alert_notifiers.h.

                                                     {
        std::lock_guard<std::mutex> lock(mutex_);
 
        for (const auto& [condition, notifier] : routes_) {
            if (condition(a) && notifier && notifier->is_ready()) {
                return notifier->notify(a);
            }
        }
 
        if (default_route_ && default_route_->is_ready()) {
            return default_route_->notify(a);
        }
 
        return common::ok();
    }

References default_route_, mutex_, and routes_.

Referenced by notify_group().

Here is the caller graph for this function:

◆ notify_group()

common::VoidResult kcenon::monitoring::routing_notifier::notify_group ( const alert_group & group )

inlineoverridevirtual

Send a notification for an alert group.

Parameters

group Alert group to notify about

Returns: Result indicating success or failure

Implements kcenon::monitoring::alert_notifier.

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

Definition at line 606 of file alert_notifiers.h.

                                                                     {
        // Route each alert individually
        for (const auto& a : group.alerts) {
            auto result = notify(a);
            if (!result.is_ok()) {
                return result;
            }
        }
        return common::ok();
    }

References kcenon::monitoring::alert_group::alerts, and notify().

Here is the call graph for this function:

◆ route_by_label()

void kcenon::monitoring::routing_notifier::route_by_label	(	const std::string &	key,
		const std::string &	value,
		std::shared_ptr< alert_notifier >	notifier )

inline

Route by label.

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

Definition at line 637 of file alert_notifiers.h.

                                                                {
        add_route(
            [key, value](const alert& a) { return a.labels.get(key) == value; },
            std::move(notifier)
        );
    }

References add_route(), kcenon::monitoring::alert_labels::get(), and kcenon::monitoring::alert::labels.

Here is the call graph for this function:

◆ route_by_severity()

void kcenon::monitoring::routing_notifier::route_by_severity	(	alert_severity	severity,
		std::shared_ptr< alert_notifier >	notifier )

inline

Route by severity.

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

Definition at line 626 of file alert_notifiers.h.

                                                                  {
        add_route(
            [severity](const alert& a) { return a.severity == severity; },
            std::move(notifier)
        );
    }

References add_route(), and kcenon::monitoring::alert::severity.

Here is the call graph for this function:

◆ set_default_route()

void kcenon::monitoring::routing_notifier::set_default_route ( std::shared_ptr< alert_notifier > notifier )

inline

Add a default route for non-matching alerts.

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

Definition at line 583 of file alert_notifiers.h.

                                                                   {
        std::lock_guard<std::mutex> lock(mutex_);
        default_route_ = std::move(notifier);
    }

References default_route_, and mutex_.