kcenon::monitoring::alert_annotations Struct Reference

Additional metadata for alert context. More...

#include <alert_types.h>

Collaboration diagram for kcenon::monitoring::alert_annotations:

Public Member Functions
	alert_annotations ()=default
	alert_annotations (std::string sum, std::string desc)

Public Attributes
std::string	summary
	Brief description.
std::string	description
	Detailed description.
std::optional< std::string >	runbook_url
	Link to runbook.
std::unordered_map< std::string, std::string >	custom
	Custom annotations.

Detailed Description

Additional metadata for alert context.

Annotations provide human-readable information about the alert but are not used for routing or deduplication.

Definition at line 163 of file alert_types.h.

Constructor & Destructor Documentation

alert_annotations() [1/2]

kcenon::monitoring::alert_annotations::alert_annotations ( )

default

alert_annotations() [2/2]

kcenon::monitoring::alert_annotations::alert_annotations ( std::string sum, std::string desc )

inline

Definition at line 171 of file alert_types.h.

        : summary(std::move(sum)), description(std::move(desc)) {}

Member Data Documentation

custom

std::unordered_map<std::string, std::string> kcenon::monitoring::alert_annotations::custom

Custom annotations.

Definition at line 167 of file alert_types.h.

Referenced by kcenon::monitoring::alert_template::render(), TEST(), and TEST().

description

std::string kcenon::monitoring::alert_annotations::description

Detailed description.

Examples

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

Definition at line 165 of file alert_types.h.

Referenced by kcenon::monitoring::create_sample_alert(), kcenon::monitoring::json_alert_formatter::format(), kcenon::monitoring::alert_template::render(), kcenon::monitoring::alert_rule::set_description(), TEST(), TEST(), and TEST().

runbook_url

std::optional<std::string> kcenon::monitoring::alert_annotations::runbook_url

Link to runbook.

Examples

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

Definition at line 166 of file alert_types.h.

Referenced by kcenon::monitoring::alert_template::render(), kcenon::monitoring::alert_rule::set_runbook_url(), TEST(), TEST(), and TEST().

summary

std::string kcenon::monitoring::alert_annotations::summary

Brief description.

Examples

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

Definition at line 164 of file alert_types.h.

Referenced by kcenon::monitoring::create_sample_alert(), kcenon::monitoring::json_alert_formatter::format(), kcenon::monitoring::text_alert_formatter::format(), kcenon::monitoring::console_color_notifier::notify(), kcenon::monitoring::alert_template::render(), kcenon::monitoring::alert_rule::set_summary(), TEST(), TEST(), and TEST().

---

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

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