# Alerta
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.
You can send Netdata alerts to Alerta to see alerts coming from many Netdata hosts or also from a multi-host Netdata configuration.
## Setup
### Prerequisites
####
- A working Alerta instance
- An Alerta API key (if authentication in Alerta is enabled)
- Access to the terminal where Netdata Agent is running
### Configuration
#### File
The configuration file name for this integration is `health_alarm_notify.conf`.
You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
```bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config health_alarm_notify.conf
```
#### Options
The following options can be defined for this notification
Config Options
| Name | Description | Default | Required |
|:----|:-----------|:-------|:--------:|
| SEND_ALERTA | Set `SEND_ALERTA` to YES | | yes |
| ALERTA_WEBHOOK_URL | set `ALERTA_WEBHOOK_URL` to the API url you defined when you installed the Alerta server. | | yes |
| ALERTA_API_KEY | Set `ALERTA_API_KEY` to your API key. | | yes |
| DEFAULT_RECIPIENT_ALERTA | 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. | | yes |
| DEFAULT_RECIPIENT_CUSTOM | Set different recipient environments per role, by editing `DEFAULT_RECIPIENT_CUSTOM` with the environment name of your choice | | no |
##### ALERTA_API_KEY
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:
1. Go to Configuration > API Keys.
2. Create a new API key called "netdata" with `write:alerts` permission.
##### DEFAULT_RECIPIENT_CUSTOM
The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:
```text
role_recipients_alerta[sysadmin]="Systems"
role_recipients_alerta[domainadmin]="Domains"
role_recipients_alerta[dba]="Databases Systems"
role_recipients_alerta[webmaster]="Marketing Development"
role_recipients_alerta[proxyadmin]="Proxy"
role_recipients_alerta[sitemgr]="Sites"
```
The values you provide should be defined as environments in `/etc/alertad.conf` with `ALLOWED_ENVIRONMENTS` option.