kcenon::monitoring::webhook_config Struct Reference

Configuration for webhook notifier. More...

#include <alert_notifiers.h>

Collaboration diagram for kcenon::monitoring::webhook_config:

Public Member Functions
webhook_config &	add_header (const std::string &key, const std::string &value)
	Add a custom header.
bool	validate () const
	Validate configuration.

Public Attributes
std::string	url
	Webhook URL.
std::string	method = "POST"
	HTTP method.
std::chrono::milliseconds	timeout {30000}
	Request timeout.
std::unordered_map< std::string, std::string >	headers
	Custom headers.
size_t	max_retries = 3
	Maximum retry attempts.
std::chrono::milliseconds	retry_delay {1000}
	Delay between retries.
bool	send_resolved = true
	Send resolved notifications.
std::string	content_type = "application/json"
	Content type header.

Detailed Description

Configuration for webhook notifier.

Examples

alert_notifiers_example.cpp.

Definition at line 37 of file alert_notifiers.h.

Member Function Documentation

add_header()

webhook_config & kcenon::monitoring::webhook_config::add_header ( const std::string & key, const std::string & value )

inline

Add a custom header.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_notifiers.h, and alert_notifiers_example.cpp.

Definition at line 50 of file alert_notifiers.h.

                                                                             {
        headers[key] = value;
        return *this;
    }

References headers.

Referenced by main().

Here is the caller graph for this function:

validate()

bool kcenon::monitoring::webhook_config::validate ( ) const

inline

Validate configuration.

Examples

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

Definition at line 58 of file alert_notifiers.h.

                          {
        return !url.empty() && timeout.count() > 0;
    }

References timeout, and url.

Referenced by kcenon::monitoring::webhook_notifier::is_ready().

Here is the caller graph for this function:

Member Data Documentation

content_type

std::string kcenon::monitoring::webhook_config::content_type = "application/json"

Content type header.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_notifiers.h, and alert_notifiers_example.cpp.

Definition at line 45 of file alert_notifiers.h.

Referenced by main(), and kcenon::monitoring::webhook_notifier::send_with_retry().

headers

std::unordered_map<std::string, std::string> kcenon::monitoring::webhook_config::headers

Custom headers.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_notifiers.h, and alert_notifiers_example.cpp.

Definition at line 41 of file alert_notifiers.h.

Referenced by add_header(), main(), and kcenon::monitoring::webhook_notifier::send_with_retry().

max_retries

size_t kcenon::monitoring::webhook_config::max_retries = 3

Maximum retry attempts.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_notifiers.h, and alert_notifiers_example.cpp.

Definition at line 42 of file alert_notifiers.h.

Referenced by main(), and kcenon::monitoring::webhook_notifier::send_with_retry().

method

std::string kcenon::monitoring::webhook_config::method = "POST"

HTTP method.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_notifiers.h, and alert_notifiers_example.cpp.

Definition at line 39 of file alert_notifiers.h.

Referenced by main(), and kcenon::monitoring::webhook_notifier::send_with_retry().

retry_delay

std::chrono::milliseconds kcenon::monitoring::webhook_config::retry_delay {1000}

Delay between retries.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_notifiers.h, and alert_notifiers_example.cpp.

Definition at line 43 of file alert_notifiers.h.

{1000};            

Referenced by main(), and kcenon::monitoring::webhook_notifier::send_with_retry().

send_resolved

bool kcenon::monitoring::webhook_config::send_resolved = true

Send resolved notifications.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_notifiers.h, and alert_notifiers_example.cpp.

Definition at line 44 of file alert_notifiers.h.

Referenced by main(), and kcenon::monitoring::webhook_notifier::notify().

timeout

std::chrono::milliseconds kcenon::monitoring::webhook_config::timeout {30000}

Request timeout.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_notifiers.h, and alert_notifiers_example.cpp.

Definition at line 40 of file alert_notifiers.h.

{30000};               

Referenced by main(), and validate().

url

std::string kcenon::monitoring::webhook_config::url

Webhook URL.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_notifiers.h, and alert_notifiers_example.cpp.

Definition at line 38 of file alert_notifiers.h.

Referenced by main(), kcenon::monitoring::webhook_notifier::name(), kcenon::monitoring::webhook_notifier::send_with_retry(), and validate().

---

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

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