kcenon::monitoring::alert_formatter Class Reference

Formats alerts for notification payloads. More...

#include <alert_notifiers.h>

Inheritance diagram for kcenon::monitoring::alert_formatter:

Collaboration diagram for kcenon::monitoring::alert_formatter:

Public Member Functions
virtual	~alert_formatter ()=default
virtual std::string	format (const alert &a) const =0
	Format a single alert.
virtual std::string	format_group (const alert_group &group) const =0
	Format an alert group.

Detailed Description

Formats alerts for notification payloads.

Base class for formatting alerts into various formats (JSON, text, etc.) for different notification targets.

Definition at line 70 of file alert_notifiers.h.

Constructor & Destructor Documentation

~alert_formatter()

virtual kcenon::monitoring::alert_formatter::~alert_formatter ( )

virtualdefault

Examples

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

Member Function Documentation

format()

virtual std::string kcenon::monitoring::alert_formatter::format ( const alert & a ) const

pure virtual

Format a single alert.

Parameters

a	Alert to format

Returns

Formatted string

Implemented in kcenon::monitoring::json_alert_formatter, and kcenon::monitoring::text_alert_formatter.

Examples

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

format_group()

virtual std::string kcenon::monitoring::alert_formatter::format_group ( const alert_group & group ) const

pure virtual

Format an alert group.

Parameters

group

Alert group to format

Returns

Formatted string

Implemented in kcenon::monitoring::json_alert_formatter, and kcenon::monitoring::text_alert_formatter.

Examples

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

---

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

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