Skip to content

Commit 6f9afcd

Browse files
committed
OBSDOCS-1862: Add missing info about alert emails
1 parent a03e2ba commit 6f9afcd

2 files changed

+39
-3
lines changed

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

+5
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

+34-3
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,45 @@ receivers:
8585
- name: watchdog
8686
- name: team-frontend-page
8787
pagerduty_configs:
88-
- routing_key: ABCD01234EFGHIJ56789
89-
http_config: # <1>
88+
- routing_key: ABCD01234EFGHIJ56789 # <1>
89+
http_config: # <2>
9090
proxy_from_environment: true
9191
authorization:
9292
credentials: xxxxxxxxxx
9393
# ...
9494
----
95-
<1> Optional: Add custom HTTP configuration for a specific receiver. That receiver does not inherit the global HTTP configuration settings.
95+
<1> PagerDuty integration key.
96+
<2> Optional: Add custom HTTP configuration for a specific receiver. That receiver does not inherit the global HTTP configuration settings.
97+
+
98+
--
99+
.Example of configuring email as an alert receiver
100+
[source,yaml]
101+
----
102+
# ...
103+
receivers:
104+
- name: default
105+
- name: watchdog
106+
- name: team-frontend-page
107+
email_configs:
108+
- to: [email protected] # <1>
109+
from: [email protected] # <2>
110+
smarthost: 'smtp.example.com:587' # <3>
111+
auth_username: [email protected] # <4>
112+
auth_password: password
113+
hello: alermanager # <5>
114+
# ...
115+
----
116+
<1> Email address to send notifications to.
117+
<2> Email address to send notifications from.
118+
<3> SMTP server address used for sending emails, including port number.
119+
<4> Authentication credentials that Alertmanager uses to connect to the SMTP server. This example uses username and password.
120+
<5> The hostname to identify to the SMTP server. If you do not include this parameter, the hostname defaults to `localhost`.
121+
--
122+
+
123+
[IMPORTANT]
124+
====
125+
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.
126+
====
96127

97128
.. Add the routing configuration:
98129
+

0 commit comments

Comments
 (0)