Add `ilert` cloud notification integration (#18736)
* feat: add ilert cloud notification integration * Apply suggestions from code review --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
Joao Cardoso committed
Oct 10, 2024 at 07:42 UTC
6a04d8461c95e7d4f9c9c4d058918447e9874c8c
1 file changed
+52
integrations/cloud-notifications/metadata.yaml
+52
@@ -535,6 +535,58 @@
535
- **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk VictorOps:
536
- Destination URL - The URL provided by VictorOps of your REST endpoint.
537
538
+- id: 'notify-cloud-ilert'
539
+ meta:
540
+ name: 'Ilert'
541
+ link: 'https://www.ilert.com/'
542
+ categories:
543
+ - notify.cloud
544
+ icon_filename: 'ilert.svg'
545
+ keywords:
546
+ - ilert
547
+ overview:
548
+ notification_description: "From the Cloud interface, you can manage your space's notification settings and from there you can add a specific configuration to get notifications delivered on ilert."
549
+ notification_limitations: ''
550
+ setup:
551
+ description: |
552
+ ### Prerequisites
553
+
554
+ To add ilert notification you need:
555
+
556
+ - A Netdata Cloud account
557
+ - Access to the space as an **Admin**
558
+ - The Space needs to be on a paid plan
559
+ - You need to have permissions on ilert to add new Alert sources.
560
+
561
+ ### Settings on ilert
562
+
563
+ 1. **Access the Alert sources Settings**: From the navigation bar, open the Alert sources drop down and click "Alert sources".
564
+ 2. **Create a New Alert source**: Click on the "+ Create a new alert source" button.
565
+ 3. **Configure an Alert source**:
566
+ - select "API integration" and click Next
567
+ - provide a name that suits the source's purpose, for example Netdata
568
+ - select Escalation policy
569
+ - select Alert grouping (optional)
570
+ - review all configurations and click "Finish setup"
571
+ 4. **Obtain the API Key**:
572
+ - Once the Alert source is created, you will be provided with an API key.
573
+ - Copy this API Key, as it will be required to configure the integration on Netdata Cloud.
574
+
575
+ ### Settings on Netdata Cloud
576
+
577
+ 1. Click on the **Space settings** cog (located above your profile icon)
578
+ 2. Click on the **Alerts & Notifications** tab
579
+ 3. Click on the **+ Add configuration** button
580
+ 4. Click on **+ Add** on the **ilert** card
581
+ 5. A modal will be presented in order to enter the required details to enable the configuration:
582
+
583
+ - **Notification settings** are Netdata specific settings
584
+ - Configuration name: provide a descriptive name for your configuration to easily identify it.
585
+ - Rooms: select the nodes or areas of your infrastructure you want to receive notifications about.
586
+ - Notification: choose the type of notifications you want to receive.
587
+ - **Integration configuration** are the required integration settings, which vary by notification method. For ilert:
588
+ - Alert Source API key.
589
+
590
- id: 'notify-cloud-webhook'
591
meta:
592
name: 'Webhook'