1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
|
# yamllint disable rule:line-length
---
- id: 'notify-cloud-discord'
meta:
name: 'Discord'
link: 'https://discord.com/'
categories:
- notify.cloud
icon_filename: 'discord.png'
keywords:
- discord
- community
overview:
notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Discord."
notification_limitations: ''
setup:
description: |
### Prerequisites
- A Netdata Cloud account
- Access to the Netdata Space as an **administrator**
- You need to have a Discord server able to receive webhooks integrations.
### Discord Server Configuration
Steps to configure your Discord server to receive [webhook notifications](https://support.discord.com/hc/en-us/articles/228383668) from Netdata:
1. Go to `Server Settings` --> `Integrations`
2. **Create Webhook** or **View Webhooks** if you already have some defined
3. Specify the **Name** and **Channel** on your new webhook
4. Use Webhook URL to add your notification configuration on Netdata UI
### Netdata Configuration Steps
1. Click on the **Space settings** cog (located above your profile icon)
2. Click on the **Notification** tab
3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
4. On the **Discord** card click on **+ Add**
5. A modal will be presented to you to enter the required details to enable the configuration:
* **Notification settings** are Netdata specific settings
- Configuration name - you can optionally provide a name for your configuration you can easily refer to it
- Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
- Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
* **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord:
- Define the type channel you want to send notifications to: **Text channel** or **Forum channel**
- Webhook URL - URL provided on Discord for the channel you want to receive your notifications.
- Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well
- id: 'notify-cloud-pagerduty'
meta:
name: 'PagerDuty'
link: 'https://www.pagerduty.com/'
categories:
- notify.cloud
icon_filename: 'pagerduty.png'
keywords:
- pagerduty
overview:
notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on PagerDuty."
notification_limitations: ''
setup:
description: |
### Prerequisites
- A Netdata Cloud account
- Access to the Netdata Space as an **administrator**
- The Netdata Space needs to be on **Business** plan or higher
- You need to have a PagerDuty service to receive events using webhooks.
### PagerDuty Server Configuration
Steps to configure your PagerDuty to receive notifications from Netdata:
1. Create a service to receive events from your services directory page on PagerDuty
2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined
3. Once the service is created you will be redirected to its configuration page, where you can copy the **integration key**, that you will need need to add to your notification configuration on Netdata UI.
### Netdata Configuration Steps
1. Click on the **Space settings** cog (located above your profile icon)
2. Click on the **Notification** tab
3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
4. On the **PagerDuty** card click on **+ Add**
5. A modal will be presented to you to enter the required details to enable the configuration:
* **Notification settings** are Netdata specific settings
- Configuration name - you can optionally provide a name for your configuration you can easily refer to it
- Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
- Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
* **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
- Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.
- id: 'notify-cloud-slack'
meta:
name: 'Slack'
link: 'https://slack.com/'
categories:
- notify.cloud
icon_filename: 'slack.png'
keywords:
- slack
overview:
notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Slack."
notification_limitations: ''
setup:
description: |
### Prerequisites
- A Netdata Cloud account
- Access to the Netdata Space as an **administrator**
- The Netdata Space needs to be on **Business** plan or higher
- You need to have a Slack app on your workspace to receive the Webhooks.
### Slack Server Configuration
Steps to configure your Slack to receive notifications from Netdata:
1. Create an app to receive webhook integrations. Check [Create an app](https://api.slack.com/apps?new_app=1) from Slack documentation for further details
2. Install the app on your workspace
3. Configure Webhook URLs for your workspace
- On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**
- At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**
- After pressing that specify the channel where you want your notifications to be delivered
- Once completed copy the Webhook URL that you will need to add to your notification configuration on Netdata UI
For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).
### Netdata Configuration Steps
1. Click on the **Space settings** cog (located above your profile icon)
2. Click on the **Notification** tab
3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
4. On the **Slack** card click on **+ Add**
5. A modal will be presented to you to enter the required details to enable the configuration:
* **Notification settings** are Netdata specific settings
- Configuration name - you can optionally provide a name for your configuration you can easily refer to it
- Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
- Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
* **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:
- Webhook URL - URL provided on Slack for the channel you want to receive your notifications.
- id: 'notify-cloud-opsgenie'
meta:
name: 'Opsgenie'
link: 'https://www.atlassian.com/software/opsgenie'
categories:
- notify.cloud
icon_filename: 'opsgenie.png'
keywords:
- opsgenie
- atlassian
overview:
notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Opsgenie."
notification_limitations: ''
setup:
description: |
### Prerequisites
- A Netdata Cloud account
- Access to the Netdata Space as an **administrator**
- The Netdata Space needs to be on **Business** plan or higher
- You need to have permissions on Opsgenie to add new integrations.
### Opsgenie Server Configuration
Steps to configure your Opsgenie to receive notifications from Netdata:
1. Go to integrations tab of your team, click **Add integration**
2. Pick **API** from available integrations. Copy your API Key and press **Save Integration**.
3. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata.
### Netdata Configuration Steps
1. Click on the **Space settings** cog (located above your profile icon)
2. Click on the **Notification** tab
3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
4. On the **Opsgenie** card click on **+ Add**
5. A modal will be presented to you to enter the required details to enable the configuration:
* **Notification settings** are Netdata specific settings
- Configuration name - you can optionally provide a name for your configuration you can easily refer to it
- Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
- Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
* **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie:
- API Key - a key provided on Opsgenie for the channel you want to receive your notifications.
- id: 'notify-cloud-mattermost'
meta:
name: 'Mattermost'
link: 'https://mattermost.com/'
categories:
- notify.cloud
icon_filename: 'mattermost.png'
keywords:
- mattermost
overview:
notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Mattermost."
notification_limitations: ''
setup:
description: |
### Prerequisites
- A Netdata Cloud account
- Access to the Netdata Space as an **administrator**
- The Netdata Space needs to be on **Business** plan or higher
- You need to have permissions on Mattermost to add new integrations.
- You need to have a Mattermost app on your workspace to receive the webhooks.
### Mattermost Server Configuration
Steps to configure your Mattermost to receive notifications from Netdata:
1. In Mattermost, go to Product menu > Integrations > Incoming Webhook
- If you don’t have the Integrations option, incoming webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. They can be enabled by a System Admin from System Console > Integrations > Integration Management. Once incoming webhooks are enabled, continue with the steps below.
2. Select Add Incoming Webhook and add a name and description for the webhook. The description can be up to 500 characters
3. Select the channel to receive webhook payloads, then select Add to create the webhook
4. You will end up with a webhook endpoint that looks like below:
`https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx`
- Treat this endpoint as a secret. Anyone who has it will be able to post messages to your Mattermost instance.
For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).
### Netdata Configuration Steps
1. Click on the **Space settings** cog (located above your profile icon)
2. Click on the **Notification** tab
3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
4. On the **Mattermost** card click on **+ Add**
5. A modal will be presented to you to enter the required details to enable the configuration:
* **Notification settings** are Netdata specific settings
- Configuration name - you can optionally provide a name for your configuration you can easily refer to it
- Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
- Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
* **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost:
- Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications
- id: 'notify-cloud-rocketchat'
meta:
name: 'RocketChat'
link: 'https://www.rocket.chat/'
categories:
- notify.cloud
icon_filename: 'rocketchat.png'
keywords:
- rocketchat
overview:
notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on RocketChat."
notification_limitations: ''
setup:
description: |
### Prerequisites
- A Netdata Cloud account
- Access to the Netdata Space as an **administrator**
- The Netdata Space needs to be on **Business** plan or higher
- You need to have permissions on Mattermost to add new integrations.
- You need to have a RocketChat app on your workspace to receive the webhooks.
### Mattermost Server Configuration
Steps to configure your RocketChat to receive notifications from Netdata:
1. In RocketChat, Navigate to Administration > Workspace > Integrations.
2. Click **+New** at the top right corner.
3. For more details about each parameter, check [create-a-new-incoming-webhook](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations#create-a-new-incoming-webhook).
4. After configuring integration, click Save.
<
|