kcenon::monitoring::alert_notifier Class Reference

Base class for alert notification handlers. More...

#include <alert_manager.h>

Inheritance diagram for kcenon::monitoring::alert_notifier:

Collaboration diagram for kcenon::monitoring::alert_notifier:

Public Member Functions
virtual	~alert_notifier ()=default
virtual std::string	name () const =0
	Get notifier name.
virtual common::VoidResult	notify (const alert &a)=0
	Send a notification for an alert.
virtual common::VoidResult	notify_group (const alert_group &group)=0
	Send a notification for an alert group.
virtual bool	is_ready () const =0
	Check if notifier is ready.

Detailed Description

Base class for alert notification handlers.

Notifiers receive alerts and send them to external systems (webhooks, logging, email, etc.).

Definition at line 409 of file alert_manager.h.

Constructor & Destructor Documentation

~alert_notifier()

virtual kcenon::monitoring::alert_notifier::~alert_notifier ( )

virtualdefault

Examples

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

Member Function Documentation

is_ready()

virtual bool kcenon::monitoring::alert_notifier::is_ready ( ) const

pure virtual

Check if notifier is ready.

Returns

True if ready to send notifications

Implemented in kcenon::monitoring::buffered_notifier, kcenon::monitoring::callback_notifier, kcenon::monitoring::console_color_notifier, kcenon::monitoring::file_notifier, kcenon::monitoring::log_notifier, kcenon::monitoring::multi_notifier, kcenon::monitoring::routing_notifier, kcenon::monitoring::statistics_notifier, and kcenon::monitoring::webhook_notifier.

Examples

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

name()

virtual std::string kcenon::monitoring::alert_notifier::name ( ) const

pure virtual

Get notifier name.

Returns

Notifier name

Implemented in kcenon::monitoring::buffered_notifier, kcenon::monitoring::callback_notifier, kcenon::monitoring::console_color_notifier, kcenon::monitoring::file_notifier, kcenon::monitoring::log_notifier, kcenon::monitoring::multi_notifier, kcenon::monitoring::routing_notifier, kcenon::monitoring::statistics_notifier, and kcenon::monitoring::webhook_notifier.

Examples

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

notify()

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

pure virtual

Send a notification for an alert.

Parameters

a	Alert to notify about

Returns

Result indicating success or failure

Implemented in kcenon::monitoring::buffered_notifier, kcenon::monitoring::callback_notifier, kcenon::monitoring::console_color_notifier, kcenon::monitoring::file_notifier, kcenon::monitoring::log_notifier, kcenon::monitoring::multi_notifier, kcenon::monitoring::routing_notifier, kcenon::monitoring::statistics_notifier, and kcenon::monitoring::webhook_notifier.

Examples

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

notify_group()

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

pure virtual

Send a notification for an alert group.

Parameters

group

Alert group to notify about

Returns

Result indicating success or failure

Implemented in kcenon::monitoring::buffered_notifier, kcenon::monitoring::callback_notifier, kcenon::monitoring::console_color_notifier, kcenon::monitoring::file_notifier, kcenon::monitoring::log_notifier, kcenon::monitoring::multi_notifier, kcenon::monitoring::routing_notifier, kcenon::monitoring::statistics_notifier, and kcenon::monitoring::webhook_notifier.

Examples

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

---

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

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