From da00a13815f0fc6bf1c835ce1b5f4c29353a68bb Mon Sep 17 00:00:00 2001 From: Eliska Romanova Date: Tue, 13 May 2025 09:07:21 +0200 Subject: [PATCH] OBSDOCS-1862: Add missing info about alert emails --- ...ing-configuring-alert-routing-console.adoc | 5 +++ ...alert-routing-default-platform-alerts.adoc | 37 +++++++++++++++++-- 2 files changed, 39 insertions(+), 3 deletions(-) diff --git a/modules/monitoring-configuring-alert-routing-console.adoc b/modules/monitoring-configuring-alert-routing-console.adoc index f1b7fae98f..326e1a8c18 100644 --- a/modules/monitoring-configuring-alert-routing-console.adoc +++ b/modules/monitoring-configuring-alert-routing-console.adoc @@ -53,6 +53,11 @@ Alternatively, you can go to the same page through the notification drawer. Sele + .. Add SMTP configuration details, including the address to send notifications from, the smarthost and port number used for sending emails, the hostname of the SMTP server, and authentication details. + +[IMPORTANT] +==== +Alertmanager requires an external SMTP server to send email alerts. To configure email alert receivers, ensure you have the necessary connection details for an external SMTP server. +==== ++ .. Select whether TLS is required. + .. Click *Show advanced configuration* if you want to edit the default option not to send resolved alerts to the receiver or edit the body of email notifications configuration. diff --git a/modules/monitoring-configuring-alert-routing-default-platform-alerts.adoc b/modules/monitoring-configuring-alert-routing-default-platform-alerts.adoc index bceab075c0..c4a1f2b7fc 100644 --- a/modules/monitoring-configuring-alert-routing-default-platform-alerts.adoc +++ b/modules/monitoring-configuring-alert-routing-default-platform-alerts.adoc @@ -85,14 +85,45 @@ receivers: - name: watchdog - name: team-frontend-page pagerduty_configs: - - routing_key: ABCD01234EFGHIJ56789 - http_config: # <1> + - routing_key: xxxxxxxxxx # <1> + http_config: # <2> proxy_from_environment: true authorization: credentials: xxxxxxxxxx # ... ---- -<1> Optional: Add custom HTTP configuration for a specific receiver. That receiver does not inherit the global HTTP configuration settings. +<1> Defines the PagerDuty integration key. +<2> Optional: Add the custom HTTP configuration for a specific receiver. That receiver does not inherit the global HTTP configuration settings. ++ +-- +.Example of configuring email as an alert receiver +[source,yaml] +---- +# ... +receivers: +- name: default +- name: watchdog +- name: team-frontend-page + email_configs: + - to: myemail@example.com # <1> + from: alertmanager@example.com # <2> + smarthost: 'smtp.example.com:587' # <3> + auth_username: alertmanager@example.com # <4> + auth_password: password + hello: alertmanager # <5> +# ... +---- +<1> Specify an email address to send notifications to. +<2> Specify an email address to send notifications from. +<3> Specify the SMTP server address used for sending emails, including the port number. +<4> Specify the authentication credentials that Alertmanager uses to connect to the SMTP server. This example uses username and password. +<5> Specify the hostname to identify to the SMTP server. If you do not include this parameter, the hostname defaults to `localhost`. +-- ++ +[IMPORTANT] +==== +Alertmanager requires an external SMTP server to send email alerts. To configure email alert receivers, ensure you have the necessary connection details for an external SMTP server. +==== .. Add the routing configuration: +