| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - id: 'notify-alerta' |
| 4 | meta: |
| 5 | name: 'Alerta' |
| 6 | link: 'https://alerta.io/' |
| 7 | categories: |
| 8 | - notify.agent |
| 9 | icon_filename: 'alerta.png' |
| 10 | keywords: |
| 11 | - Alerta |
| 12 | overview: |
| 13 | notification_description: | |
| 14 | The [Alerta](https://alerta.io/) monitoring system is a tool used to consolidate and de-duplicate alerts from multiple sources for quick ‘at-a-glance’ visualization. With just one system you can monitor alerts from many other monitoring tools on a single screen. |
| 15 | You can send Netdata alerts to Alerta to see alerts coming from many Netdata hosts or also from a multi-host Netdata configuration. |
| 16 | notification_limitations: '' |
| 17 | setup: |
| 18 | prerequisites: |
| 19 | list: |
| 20 | - title: '' |
| 21 | description: | |
| 22 | - A working Alerta instance |
| 23 | - An Alerta API key (if authentication in Alerta is enabled) |
| 24 | - Access to the terminal where Netdata Agent is running |
| 25 | configuration: |
| 26 | file: |
| 27 | name: 'health_alarm_notify.conf' |
| 28 | options: |
| 29 | description: 'The following options can be defined for this notification' |
| 30 | folding: |
| 31 | title: 'Config Options' |
| 32 | enabled: true |
| 33 | list: |
| 34 | - name: 'SEND_ALERTA' |
| 35 | default_value: '' |
| 36 | description: "Set `SEND_ALERTA` to YES" |
| 37 | required: true |
| 38 | - name: 'ALERTA_WEBHOOK_URL' |
| 39 | default_value: '' |
| 40 | description: "set `ALERTA_WEBHOOK_URL` to the API url you defined when you installed the Alerta server." |
| 41 | required: true |
| 42 | - name: 'ALERTA_API_KEY' |
| 43 | default_value: '' |
| 44 | description: "Set `ALERTA_API_KEY` to your API key." |
| 45 | required: true |
| 46 | detailed_description: | |
| 47 | You will need an API key to send messages from any source, if Alerta is configured to use authentication (recommended). To create a new API key: |
| 48 | 1. Go to Configuration > API Keys. |
| 49 | 2. Create a new API key called "netdata" with `write:alerts` permission. |
| 50 | - name: 'DEFAULT_RECIPIENT_ALERTA' |
| 51 | default_value: '' |
| 52 | description: "Set `DEFAULT_RECIPIENT_ALERTA` to the default recipient environment you want the alert notifications to be sent to. All roles will default to this variable if left unconfigured." |
| 53 | required: true |
| 54 | - name: 'DEFAULT_RECIPIENT_CUSTOM' |
| 55 | default_value: '' |
| 56 | description: "Set different recipient environments per role, by editing `DEFAULT_RECIPIENT_CUSTOM` with the environment name of your choice" |
| 57 | required: false |
| 58 | detailed_description: | |
| 59 | The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file: |
| 60 | |
| 61 | ```text |
| 62 | role_recipients_alerta[sysadmin]="Systems" |
| 63 | role_recipients_alerta[domainadmin]="Domains" |
| 64 | role_recipients_alerta[dba]="Databases Systems" |
| 65 | role_recipients_alerta[webmaster]="Marketing Development" |
| 66 | role_recipients_alerta[proxyadmin]="Proxy" |
| 67 | role_recipients_alerta[sitemgr]="Sites" |
| 68 | ``` |
| 69 | |
| 70 | The values you provide should be defined as environments in `/etc/alertad.conf` with `ALLOWED_ENVIRONMENTS` option. |
| 71 | examples: |
| 72 | folding: |
| 73 | enabled: true |
| 74 | title: '' |
| 75 | list: |
| 76 | - name: 'Basic Configuration' |
| 77 | folding: |
| 78 | enabled: false |
| 79 | description: '' |
| 80 | config: | |
| 81 | #------------------------------------------------------------------------------ |
| 82 | # alerta (alerta.io) global notification options |
| 83 | |
| 84 | SEND_ALERTA="YES" |
| 85 | ALERTA_WEBHOOK_URL="http://yourserver/alerta/api" |
| 86 | ALERTA_API_KEY="INSERT_YOUR_API_KEY_HERE" |
| 87 | DEFAULT_RECIPIENT_ALERTA="Production" |
| 88 | troubleshooting: |
| 89 | problems: |
| 90 | list: [] |