@cryptotaxi247 / netdata-1 / commits / 72e9ce1e3

Updated all cloud notifications except generic webhook (#15615)

Satyadeep Ashwathnarayana committed Jul 28, 2023 at 19:06 UTC 72e9ce1e38fa186e16024ccfe551339b6c6165e6
1 file changed +376 -2
integrations/cloud-notifications/metadata.yaml
+376 -2
@@ -19,10 +19,10 @@
19 - title: 'Netdata Access'
20 description: |
21 - A Netdata Cloud account
22 - - Access to the Netdata Space as an administrator
22 + - Access to the Netdata Space as an **administrator**
23 - title: 'Discord Server Configuration'
24 description: |
25 - You need to have a Discord server able to receive [webhook integrations](https://support.discord.com/hc/en-us/articles/228383668).
25 + You need to have a Discord server able to receive [webhooks integrations](https://support.discord.com/hc/en-us/articles/228383668).
26 Steps to configure your Discord server to receive notifications from Netdata:
27
28 1. Go to `Server Settings` --> `Integrations`
@@ -74,3 +74,377 @@
74 enabled: false
75 description: ''
76 config: ''
77 +- id: 'notify-pagerduty'
78 + meta:
79 + name: 'PagerDuty'
80 + link: 'https://www.pagerduty.com/'
81 + categories:
82 + - notify.cloud
83 + icon_filename: 'pagerduty.png'
84 + keywords:
85 + - pagerduty
86 + overview:
87 + notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on PagerDuty."
88 + notification_limitations: ''
89 + setup:
90 + prerequisites:
91 + list:
92 + - title: 'Netdata Access'
93 + description: |
94 + - A Netdata Cloud account
95 + - Access to the Netdata Space as an **administrator**
96 + - The Netdata Space needs to be on **Business** plan or higher
97 + - title: 'Discord Server Configuration'
98 + description: |
99 + You need to have a PagerDuty service to receive events using webhooks.
100 + Steps to configure your PagerDuty to receive notifications from Netdata:
101 +
102 + 1. Create a service to receive events from your services directory page on PagerDuty
103 + 2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined
104 + 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.
105 +
106 + - title: ''
107 + description: |
108 +
109 + ## Configuration Steps
110 +
111 + 1. Click on the **Space settings** cog (located above your profile icon)
112 + 2. Click on the **Notification** tab
113 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
114 + 4. On the **PagerDuty** card click on **+ Add**
115 + 5. A modal will be presented to you to enter the required details to enable the configuration:
116 + * **Notification settings** are Netdata specific settings
117 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
118 + - 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
119 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
120 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
121 + - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.
122 +
123 +
124 + configuration:
125 + file:
126 + name: ''
127 + description: ''
128 + options:
129 + description: ''
130 + folding:
131 + title: ''
132 + enabled: true
133 + list:
134 + - name: ''
135 + default_value: ''
136 + description: ''
137 + required: false
138 + examples:
139 + folding:
140 + enabled: true
141 + title: ''
142 + list:
143 + - name: ''
144 + folding:
145 + enabled: false
146 + description: ''
147 + config: ''
148 +- id: 'notify-slack'
149 + meta:
150 + name: 'Slack'
151 + link: 'https://slack.com/'
152 + categories:
153 + - notify.cloud
154 + icon_filename: 'slack.png'
155 + keywords:
156 + - slack
157 + overview:
158 + notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Slack."
159 + notification_limitations: ''
160 + setup:
161 + prerequisites:
162 + list:
163 + - title: 'Netdata Access'
164 + description: |
165 + - A Netdata Cloud account
166 + - Access to the Netdata Space as an **administrator**
167 + - The Netdata Space needs to be on **Business** plan or higher
168 + - title: 'Slack Server Configuration'
169 + description: |
170 + You need to have a Slack app on your workspace to receive the Webhooks.
171 + Steps to configure your Slack to receive notifications from Netdata:
172 +
173 + 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
174 + 2. Install the app on your workspace
175 + 3. Configure Webhook URLs for your workspace
176 + - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**
177 + - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**
178 + - After pressing that specify the channel where you want your notifications to be delivered
179 + - Once completed copy the Webhook URL that you will need to add to your notification configuration on Netdata UI
180 +
181 + For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).
182 +
183 + - title: ''
184 + description: |
185 +
186 + ## Configuration Steps
187 +
188 + 1. Click on the **Space settings** cog (located above your profile icon)
189 + 2. Click on the **Notification** tab
190 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
191 + 4. On the **Slack** card click on **+ Add**
192 + 5. A modal will be presented to you to enter the required details to enable the configuration:
193 + * **Notification settings** are Netdata specific settings
194 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
195 + - 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
196 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
197 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:
198 + - Webhook URL - URL provided on Slack for the channel you want to receive your notifications.
199 +
200 +
201 + configuration:
202 + file:
203 + name: ''
204 + description: ''
205 + options:
206 + description: ''
207 + folding:
208 + title: ''
209 + enabled: true
210 + list:
211 + - name: ''
212 + default_value: ''
213 + description: ''
214 + required: false
215 + examples:
216 + folding:
217 + enabled: true
218 + title: ''
219 + list:
220 + - name: ''
221 + folding:
222 + enabled: false
223 + description: ''
224 + config: ''
225 +- id: 'notify-opsgenie'
226 + meta:
227 + name: 'Opsgenie'
228 + link: 'https://www.atlassian.com/software/opsgenie'
229 + categories:
230 + - notify.cloud
231 + icon_filename: 'opsgenie.png'
232 + keywords:
233 + - opsgenie
234 + - atlassian
235 + overview:
236 + notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Opsgenie."
237 + notification_limitations: ''
238 + setup:
239 + prerequisites:
240 + list:
241 + - title: 'Netdata Access'
242 + description: |
243 + - A Netdata Cloud account
244 + - Access to the Netdata Space as an **administrator**
245 + - The Netdata Space needs to be on **Business** plan or higher
246 + - title: 'Opsgenie Configuration'
247 + description: |
248 + You need to have permissions on Opsgenie to add new integrations.
249 + Steps to configure your Opsgenie to receive notifications from Netdata:
250 +
251 + 1. Go to integrations tab of your team, click **Add integration**
252 + 2. Pick **API** from available integrations. Copy your API Key and press **Save Integration**.
253 + 3. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata.
254 +
255 + - title: ''
256 + description: |
257 +
258 + ## Configuration Steps
259 +
260 + 1. Click on the **Space settings** cog (located above your profile icon)
261 + 2. Click on the **Notification** tab
262 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
263 + 4. On the **Opsgenie** card click on **+ Add**
264 + 5. A modal will be presented to you to enter the required details to enable the configuration:
265 + * **Notification settings** are Netdata specific settings
266 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
267 + - 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
268 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
269 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie:
270 + - API Key - a key provided on Opsgenie for the channel you want to receive your notifications.
271 +
272 +
273 + configuration:
274 + file:
275 + name: ''
276 + description: ''
277 + options:
278 + description: ''
279 + folding:
280 + title: ''
281 + enabled: true
282 + list:
283 + - name: ''
284 + default_value: ''
285 + description: ''
286 + required: false
287 + examples:
288 + folding:
289 + enabled: true
290 + title: ''
291 + list:
292 + - name: ''
293 + folding:
294 + enabled: false
295 + description: ''
296 + config: ''
297 +- id: 'notify-mattermost'
298 + meta:
299 + name: 'Mattermost'
300 + link: 'https://mattermost.com/'
301 + categories:
302 + - notify.cloud
303 + icon_filename: 'mattermost.png'
304 + keywords:
305 + - mattermost
306 + overview:
307 + notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Mattermost."
308 + notification_limitations: ''
309 + setup:
310 + prerequisites:
311 + list:
312 + - title: 'Netdata Access'
313 + description: |
314 + - A Netdata Cloud account
315 + - Access to the Netdata Space as an **administrator**
316 + - The Netdata Space needs to be on **Business** plan or higher
317 + - title: 'Mattermost Configuration'
318 + description: |
319 + You need to have a Mattermost app on your workspace to receive the webhooks.
320 + Steps to configure your Mattermost to receive notifications from Netdata:
321 +
322 + 1. In Mattermost, go to Product menu > Integrations > Incoming Webhook
323 + - 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.
324 + 2. Select Add Incoming Webhook and add a name and description for the webhook. The description can be up to 500 characters
325 + 3. Select the channel to receive webhook payloads, then select Add to create the webhook
326 + 4. You will end up with a webhook endpoint that looks like below:
327 + `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx`
328 +
329 + - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your Mattermost instance.
330 +
331 + For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).
332 +
333 + - title: ''
334 + description: |
335 +
336 + ## Configuration Steps
337 +
338 + 1. Click on the **Space settings** cog (located above your profile icon)
339 + 2. Click on the **Notification** tab
340 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
341 + 4. On the **Mattermost** card click on **+ Add**
342 + 5. A modal will be presented to you to enter the required details to enable the configuration:
343 + * **Notification settings** are Netdata specific settings
344 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
345 + - 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
346 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
347 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost:
348 + - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications
349 +
350 + configuration:
351 + file:
352 + name: ''
353 + description: ''
354 + options:
355 + description: ''
356 + folding:
357 + title: ''
358 + enabled: true
359 + list:
360 + - name: ''
361 + default_value: ''
362 + description: ''
363 + required: false
364 + examples:
365 + folding:
366 + enabled: true
367 + title: ''
368 + list:
369 + - name: ''
370 + folding:
371 + enabled: false
372 + description: ''
373 + config: ''
374 +- id: 'notify-rocketchat'
375 + meta:
376 + name: 'RocketChat'
377 + link: 'https://www.rocket.chat/'
378 + categories:
379 + - notify.cloud
380 + icon_filename: 'rocketchat.png'
381 + keywords:
382 + - rocketchat
383 + overview:
384 + notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on RocketChat."
385 + notification_limitations: ''
386 + setup:
387 + prerequisites:
388 + list:
389 + - title: 'Netdata Access'
390 + description: |
391 + - A Netdata Cloud account
392 + - Access to the Netdata Space as an **administrator**
393 + - The Netdata Space needs to be on **Business** plan or higher
394 + - title: 'RocketChat Configuration'
395 + description: |
396 + You need to have a RocketChat app on your workspace to receive the webhooks.
397 + Steps to configure your RocketChat to receive notifications from Netdata:
398 +
399 + 1. In RocketChat, Navigate to Administration > Workspace > Integrations.
400 + 2. Click **+New** at the top right corner.
401 + 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).
402 + 4. After configuring integration, click Save.
403 + 5. You will end up with a webhook endpoint that looks like below:
404 + `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`
405 + - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your RocketChat instance.
406 +
407 +
408 + For more details please check RocketChat's article Incoming webhooks for [RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/).
409 +
410 + - title: ''
411 + description: |
412 +
413 + ## Configuration Steps
414 +
415 + 1. Click on the **Space settings** cog (located above your profile icon)
416 + 2. Click on the **Notification** tab
417 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
418 + 4. On the **RocketChat** card click on **+ Add**
419 + 5. A modal will be presented to you to enter the required details to enable the configuration:
420 + * **Notification settings** are Netdata specific settings
421 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
422 + - 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
423 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
424 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:
425 + - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications.
426 +
427 + configuration:
428 + file:
429 + name: ''
430 + description: ''
431 + options:
432 + description: ''
433 + folding:
434 + title: ''
435 + enabled: true
436 + list:
437 + - name: ''
438 + default_value: ''
439 + description: ''
440 + required: false
441 + examples:
442 + folding:
443 + enabled: true
444 + title: ''
445 + list:
446 + - name: ''
447 + folding:
448 + enabled: false
449 + description: ''
450 + config: ''
\ No newline at end of file