@@ -6,16 +6,15 @@ sidebar_label: Create alerts
66import RelatedPages from "@site/src /components/RelatedPages";
77
88OpenSearch® alerting feature sends notifications when data from one or more indices meets certain conditions that can be customized.
9- Use case
10- examples are such as monitoring for HTTP status code 503, CPU load
11- average above certain percentage or watch for counts of a specific
12- keyword in logs for a specific amount of interval, notification to be
13- configured to be sent via email, slack or custom webhooks and other
14- destination.
15-
16- In the following example we are using Slack as the destination and a
9+ Use case examples include monitoring for HTTP status code 503, CPU load
10+ average above a certain percentage, or watching for counts of a specific
11+ keyword in logs for a specific interval. Notifications can be
12+ configured to be sent via email, Slack, or custom webhooks and other
13+ channels.
14+
15+ In the following example, we use Slack as the notification channel and a
1716` sample-host-health ` index as datasource to create a simple alert to
18- check cpu load. An action will be triggered when average of
17+ check CPU load. An action will be triggered when the average of
1918` cpu_usage_percentage ` over ` 3 ` minutes is above ` 75% ` .
2019
2120## Create using Dashboards UI
@@ -26,54 +25,62 @@ To create an alert via OpenSearch Dashboards interface:
2625 your OpenSearch service.
2726
28271 . On the service's ** Overview** screen, in the ** Connection
29- information** section and select the ** OpenSearch Dashboards** tab.
28+ information** section, select the ** OpenSearch Dashboards** tab.
3029
31- This opens the OpenSearch Dashboard
30+ This opens the OpenSearch Dashboard.
3231
33321 . Within the OpenSearch Dashboard, access the left side panel and
3433 select ** Alerting** under the OpenSearch Plugins section.
3534
36- To configure each alert the following needs to be created, we will
37- walk- through configuration of each section.
35+ To configure each alert, the following needs to be created. We will
36+ walk through the configuration of each section:
3837
39- - ` Destination `
38+ - ` Notification channel `
4039- ` Monitor `
4140- ` Data source `
4241- ` Query `
4342- ` Trigger `
4443
45- ## Create a destination
44+ ## Create a notification channel
4645
47- Destination is a location for notifications to be delivered when an
46+ A notification channel is a location for notifications to be delivered when an
4847action is triggered.
4948
50- 1 . Open the ** Destination** tab and click ** Add destination**
49+ 1 . In the OpenSearch Dashboard, select ** Notifications** from the left side panel.
50+
51+ 1 . Select the ** Channels** tab and click ** Create channel** .
52+
53+ 1 . Fill in the fields under ** Channel details** .
5154
52- 1 . Fill in the fields under ** Destination** .
5355 Fill ` slack-test ` as the ** Name** .
54- Select ` Slack ` under ** Type** .
5556
56- Paste your slack webhook ` https://your_slack_webhook_URL ` under
57+ Provide a description (optional).
58+
59+ Select ` Slack ` under ** Channel type** .
60+
61+ Paste your Slack webhook URL ` https://your_slack_webhook_URL ` under
5762 ** Webhook URL** .
5863
64+ 1 . Click ** Create** .
65+
5966::: note
60- Destination Type can be: ` Amazon Chime ` , ` Slack ` , ` Custom webhook ` or
61- ` Email `
67+ Channel types can be: ` Amazon Chime ` , ` Amazon SNS ` , ` Slack ` , ` Custom webhook ` , ` Email ` ,
68+ or ` Microsoft Teams ` .
6269:::
6370
6471::: important
6572When using email, ensure you have an SMTP server configured for a
6673valid domain to deliver email notifications.
6774:::
6875
69- ## Configure authentication for email destination
76+ ## Configure authentication for email channel
7077
7178This section shows how to authenticate the sender account before sending
7279email messages. To authenticate when sending emails, the credentials
7380need to be added first to the OpenSearch keystore. Perform this step
74- before configuring an email destination that requires authentication.
81+ before configuring an email channel that requires authentication.
7582
76- 1 . In ** Overview** screen of your OpenSearch service, scroll to the
83+ 1 . In the ** Overview** screen of your OpenSearch service, scroll to the
7784 ** Advanced configuration** section.
7885
79861 . Select ** Change** and ** +Add configuration option** .
@@ -85,36 +92,40 @@ before configuring an email destination that requires authentication.
8592 - ` email_sender_username `
8693 - ` email_sender_password `
8794
88- At the end of this step the email account credentials will be added
95+ At the end of this step, the email account credentials will be added
8996 to the OpenSearch keystore.
9097
98+ 1 . Select ** Save advanced configuration** .
99+
91100In OpenSearch Dashboards:
92101
93- 1 . Select ** Save advanced configuration ** .
102+ 1 . Select ** Notifications ** from the left side panel .
94103
95- 1 . Open the ** Destination** tab in the OpenSearch Dashboard and select
96- ** Add destination** .
104+ 1 . Select the ** Channels** tab and click ** Create channel** .
97105
98- 1 . Fill in the fields under ** Destination ** .
106+ 1 . Fill in the fields under ** Channel details ** .
99107
100108 Fill ` email-test ` as the ** Name** .
101109
102- Select ` Email ` under ** Type ** .
110+ Select ` Email ` under ** Channel type ** .
103111
104- We assume that no senders exist yet. Click ** Manage Senders** > ** New sender** .
112+ Under ** Email settings** , click ** Manage senders** if no senders exist yet, then
113+ select ** Create sender** .
105114
106115 Assign a name to the sender. This name should match the property ` email_sender_name `
107- from step 1 .
116+ from the keystore configuration .
108117
109118 Fill in the information required by the form and select SSL or TLS
110119 in ** Encryption method** .
111120
112- 1 . Complete the form with the recipients, by
113- creating email groups in ** Manage email groups** if necessary.
121+ 1 . Complete the form with the recipients. You can create email groups in
122+ ** Manage email groups** if necessary.
123+
124+ 1 . Click ** Create** .
114125
115126## Create a monitor
116127
117- Monitor is a job that runs on a defined schedule and queries OpenSearch
128+ A monitor is a job that runs on a defined schedule and queries OpenSearch
118129indices.
119130
1201311 . Open the ** Monitors** tab and click ** Create monitor** .
@@ -129,36 +140,36 @@ indices.
129140
130141 Select ` By interval ` under ** Schedule** ** Frequency** .
131142
132- Under ** Run every** , select ` 1 ` ` Minutes ` ,
143+ Under ** Run every** , select ` 1 ` ` Minutes ` .
133144
134145::: note
135- Schedule Frequency can be ` By internal ` , ` Daily ` ` Weekly ` ` Monthly ` ,
146+ Schedule Frequency can be ` By interval ` , ` Daily ` , ` Weekly ` , ` Monthly ` , or
136147` Custom CRON expression ` .
137148:::
138149
1391501 . Fill in the fields under ** Data source** .
140151
141152 Data source is the OpenSearch indices to query.
142153
143- Fill ` sample-host-health ` into ** index ** .
154+ Fill ` sample-host-health ` into ** Index ** .
144155
145156 Fill ` timestamp ` into ** Time field** .
146157
147- 1 . ** Query**
158+ 1 . Configure the ** Query** .
148159
149160 Query defines the fields to query from indices and how to evaluate
150161 the results.
151162
152- Under ** Metrics** click ** Add metric** .
163+ Under ** Metrics** , click ** Add metric** .
153164
154165 Select ` average() ` under ** Aggregation** and ` cpu_usage_percentage `
155- under ** Field** , click ** Save** .
166+ under ** Field** , then click ** Save** .
156167
157168 Fill ` 3 ` under ** Time range for the last** and select ` minutes ` .
158169
159170## Create a trigger
160171
161- Triggers is a defined conditions from the queries results from monitor.
172+ A trigger is a defined condition from the query results from the monitor.
162173If conditions are met, alerts are generated.
163174
1641751 . Select ** Add trigger** .
@@ -167,38 +178,39 @@ If conditions are met, alerts are generated.
167178
168179 Select ` 1 (Highest) ` for ** Severity level** .
169180
170- Under ** Trigger condition** select ` IS ABOVE ` from the drop-down
181+ Under ** Trigger condition** , select ` IS ABOVE ` from the drop-down
171182 menu and fill ` 75 ` into the number field.
172183
173184::: note
174- You can see a visual graph below trigger with the index data and the
185+ You can see a visual graph below the trigger with the index data and the
175186trigger condition you have defined as a red line.
176187:::
177188
178- 1 . Fill in the fields under ** Actions**
189+ 1 . Fill in the fields under ** Actions** .
179190
180- Actions defines the destination for notification alerts when trigger
191+ Actions define the notification channel for alerts when trigger
181192 conditions are met.
182193
183194 Fill in ` slack ` as ** Action name** .
184195
185- Select ` slack-test ` under ** Destination ** .
196+ Select ` slack-test ` under ** Notification channel ** .
186197
187198 Fill in ` High CPU Test Alert ` as ** Message subject** .
188199
189200::: note
190- Multiple Actions can be defined, in this example we will define one
191- action to send notification to destination we have defined in step 4
201+ Multiple actions can be defined. In this example, we define one
202+ action to send notifications to the channel we created earlier.
192203:::
193204
194205## Alert message
195206
196- ** Message** can be adjusted as needed, check ** Message Preview** to see
197- the sample and use ** Send test message** to validate notification
198- delivery
207+ The ** Message** can be adjusted as needed. Check ** Message Preview** to see
208+ a sample and use ** Send test message** to validate notification
209+ delivery.
199210
200211Select ** Create** .
201212
202213<RelatedPages />
203214
204215- [ Alerting monitors configuration] ( https://opensearch.org/docs/latest/monitoring-plugins/alerting/monitors/ )
216+ - [ Notifications plugin] ( https://opensearch.org/docs/latest/observing-your-data/notifications/index/ )
0 commit comments