Skip to content

Commit 8f4ac30

Browse files
committed
OBSDOCS-1862: Add missing info about alert emails
1 parent 8b10085 commit 8f4ac30

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

modules/monitoring-configuring-alert-routing-console.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@ Alternatively, you can go to the same page through the notification drawer. Sele
5353
+
5454
.. 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.
5555
+
56+
[IMPORTANT]
57+
====
58+
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.
59+
====
60+
+
5661
.. Select whether TLS is required.
5762
+
5863
.. 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.

modules/monitoring-configuring-alert-routing-default-platform-alerts.adoc

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,40 @@ receivers:
8282
- name: watchdog
8383
- name: team-frontend-page
8484
pagerduty_configs:
85-
- routing_key: ABCD01234EFGHIJ56789
85+
- routing_key: xxxxxxxxxx # <1>
8686
# ...
8787
----
88+
<1> Defines the PagerDuty integration key.
89+
+
90+
--
91+
.Example of configuring email as an alert receiver
92+
[source,yaml]
93+
----
94+
# ...
95+
receivers:
96+
- name: default
97+
- name: watchdog
98+
- name: team-frontend-page
99+
email_configs:
100+
- to: myemail@example.com # <1>
101+
from: alertmanager@example.com # <2>
102+
smarthost: 'smtp.example.com:587' # <3>
103+
auth_username: alertmanager@example.com # <4>
104+
auth_password: password
105+
hello: alertmanager # <5>
106+
# ...
107+
----
108+
<1> Specify an email address to send notifications to.
109+
<2> Specify an email address to send notifications from.
110+
<3> Specify the SMTP server address used for sending emails, including the port number.
111+
<4> Specify the authentication credentials that Alertmanager uses to connect to the SMTP server. This example uses username and password.
112+
<5> Specify the hostname to identify to the SMTP server. If you do not include this parameter, the hostname defaults to `localhost`.
113+
--
114+
+
115+
[IMPORTANT]
116+
====
117+
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.
118+
====
88119

89120
.. Add the routing configuration:
90121
+

0 commit comments

Comments
 (0)