Email

Send notifications via Email using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.

Setup

Prerequisites

• A working sendmail command is required for email alerts to work. Almost all MTAs provide a sendmail interface. Netdata sends all emails as user netdata, so make sure your sendmail works for local users.

• Access to the terminal where Netdata Agent is running

• When running Netdata with Docker Compose the emails are sent with msmtp, and you need a basic configuration for it to work.

  • Add a msmtprc config file on your Docker root folder, and edit it according to your needs.

  • Link it into your Netdata container with this:

        volumes:
          - /path/to/netdata-docker/msmtprc:/etc/msmtprc:ro

  • Update your container with docker compose up -d.

Configuration

File

The configuration file name for this integration is health_alarm_notify.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

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
EMAIL_SENDER	You can change EMAIL_SENDER to the email address sending the notifications.	netdata	no
SEND_EMAIL	Set SEND_EMAIL to YES	YES	yes
DEFAULT_RECIPIENT_EMAIL	Set DEFAULT_RECIPIENT_EMAIL to the email address you want the email to be sent by default. You can define multiple email addresses like this: [email protected] [email protected].	root	yes

DEFAULT_RECIPIENT_EMAIL

All roles will default to this variable if left unconfigured. The DEFAULT_RECIPIENT_CUSTOM can be edited in the following entries at the bottom of the same file:

role_recipients_email[sysadmin]="[email protected]"
role_recipients_email[domainadmin]="[email protected]"
role_recipients_email[dba]="[email protected] [email protected]"
role_recipients_email[webmaster]="[email protected] [email protected]"
role_recipients_email[proxyadmin]="[email protected]"
role_recipients_email[sitemgr]="[email protected]"

Examples

Basic Configuration

#------------------------------------------------------------------------------
# email global notification options

EMAIL_SENDER="[email protected]"
SEND_EMAIL="YES"
DEFAULT_RECIPIENT_EMAIL="[email protected]"

Troubleshooting

Test Notification

You can run the following command by hand, to test alerts configuration:

# become user netdata
sudo su -s /bin/bash netdata

# enable debugging info on the console
export NETDATA_ALARM_NOTIFY_DEBUG=1

# send test alarms to sysadmin
/usr/libexec/netdata/plugins.d/alarm-notify.sh test

# send test alarms to any role
/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"

Note that this will test all alert mechanisms for the selected role.