Template engine for alert messages. More...

#include <alert_config.h>

Collaboration diagram for kcenon::monitoring::alert_template:

Public Member Functions
	alert_template (std::string template_str)
	Construct with template string.

void	set (const std::string &key, const std::string &value)
	Set a custom variable value.

std::string	render (const alert &a) const
	Render template with alert data.

const std::string &	template_string () const
	Get template string.

common::VoidResult	validate () const
	Validate template syntax.

Static Private Member Functions
static std::string	format_value (double value)

static std::string	substitute_variables (const std::string &input, const std::unordered_map< std::string, std::string > &vars)

Private Attributes
std::string	template_str_

std::unordered_map< std::string, std::string >	custom_vars_

Detailed Description

Template engine for alert messages.

Supports variable substitution in alert summaries and descriptions using ${variable} syntax. Variables can include alert properties, labels, and annotations.

Built-in variables:

${name} - Alert name
${state} - Alert state (pending, firing, resolved)
${severity} - Alert severity
${value} - Current metric value
${threshold} - Trigger threshold (if applicable)
${labels.X} - Label value for key X
${annotations.X} - Annotation value for key X

Definition at line 58 of file alert_config.h.

Constructor & Destructor Documentation

◆ alert_template()

kcenon::monitoring::alert_template::alert_template ( std::string template_str )

inlineexplicit

Construct with template string.

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

Definition at line 63 of file alert_config.h.

64 : template_str_(std::move(template_str)) {}

kcenon::monitoring::alert_template::template_str_

std::string template_str_

Definition alert_config.h:172

Member Function Documentation

◆ format_value()

static std::string kcenon::monitoring::alert_template::format_value ( double value )

inlinestaticprivate

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

Definition at line 138 of file alert_config.h.

                                                {
        std::ostringstream oss;
        oss << std::fixed << std::setprecision(2) << value;
        return oss.str();
    }

Referenced by render().

Here is the caller graph for this function:

◆ render()

std::string kcenon::monitoring::alert_template::render ( const alert & a ) const

inline

Render template with alert data.

Parameters

a	Alert providing context

Returns: Rendered string

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

Definition at line 78 of file alert_config.h.

                                           {
        std::string result = template_str_;
 
        // Build variable map
        std::unordered_map<std::string, std::string> vars;
 
        // Alert properties
        vars["name"] = a.name;
        vars["state"] = alert_state_to_string(a.state);
        vars["severity"] = alert_severity_to_string(a.severity);
        vars["value"] = format_value(a.value);
        vars["fingerprint"] = a.fingerprint();
        vars["rule_name"] = a.rule_name;
        vars["group_key"] = a.group_key;
 
        // Labels
        for (const auto& [key, value] : a.labels.labels) {
            vars["labels." + key] = value;
        }
 
        // Annotations
        vars["annotations.summary"] = a.annotations.summary;
        vars["annotations.description"] = a.annotations.description;
        if (a.annotations.runbook_url) {
            vars["annotations.runbook_url"] = *a.annotations.runbook_url;
        }
        for (const auto& [key, value] : a.annotations.custom) {
            vars["annotations." + key] = value;
        }
 
        // Custom variables
        for (const auto& [key, value] : custom_vars_) {
            vars[key] = value;
        }
 
        // Substitute variables
        result = substitute_variables(result, vars);
 
        return result;
    }

Here is the call graph for this function:

◆ set()

void kcenon::monitoring::alert_template::set	(	const std::string &	key,
		const std::string &	value )

inline

Set a custom variable value.

Definition at line 69 of file alert_config.h.

                                                           {
        custom_vars_[key] = value;
    }

References custom_vars_.

◆ substitute_variables()

static std::string kcenon::monitoring::alert_template::substitute_variables	(	const std::string &	input,
		const std::unordered_map< std::string, std::string > &	vars )

inlinestaticprivate

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

Definition at line 144 of file alert_config.h.

                                                                {
        std::string result = input;
        std::regex pattern(R"(\$\{([^}]+)\})");
 
        std::string::const_iterator start = result.cbegin();
        std::smatch match;
        std::string output;
 
        while (std::regex_search(start, result.cend(), match, pattern)) {
            output += std::string(start, match[0].first);
 
            std::string var_name = match[1].str();
            auto it = vars.find(var_name);
            if (it != vars.end()) {
                output += it->second;
            } else {
                output += match[0].str();  // Keep original if not found
            }
 
            start = match[0].second;
        }
        output += std::string(start, result.cend());
 
        return output;
    }

Referenced by render().

Here is the caller graph for this function:

◆ template_string()

const std::string & kcenon::monitoring::alert_template::template_string ( ) const

inline

Get template string.

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

Definition at line 122 of file alert_config.h.

122{ return template_str_; }

References template_str_.

◆ validate()

common::VoidResult kcenon::monitoring::alert_template::validate ( ) const

inline

Validate template syntax.

Returns: Result with validation errors if any

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

Definition at line 128 of file alert_config.h.

                                      {
        // Check for unclosed variable references
        std::regex pattern(R"(\$\{[^}]*$)");
        if (std::regex_search(template_str_, pattern)) {
            return common::VoidResult::err(error_info(monitoring_error_code::validation_failed, "Unclosed variable reference in template").to_common_error());
        }
        return common::ok();
    }

References template_str_, and kcenon::monitoring::validation_failed.

Member Data Documentation

◆ custom_vars_

std::unordered_map<std::string, std::string> kcenon::monitoring::alert_template::custom_vars_

private

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

Definition at line 173 of file alert_config.h.

Referenced by render(), and set().

◆ template_str_

std::string kcenon::monitoring::alert_template::template_str_

private

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

Definition at line 172 of file alert_config.h.

Referenced by render(), template_string(), and validate().

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

include/kcenon/monitoring/alert/alert_config.h

Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ alert_template()

Member Function Documentation

◆ format_value()

◆ render()

◆ set()

◆ substitute_variables()

◆ template_string()

◆ validate()

Member Data Documentation

◆ custom_vars_

◆ template_str_