From b485aab7e71c1625cfc27e0f92c9509f42378458 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 5 May 2024 13:19:16 +0200 Subject: Adding upstream version 1.45.3+dfsg. Signed-off-by: Daniel Baumann --- health/notifications/email/README.md | 114 ----------------------------------- 1 file changed, 114 deletions(-) delete mode 100644 health/notifications/email/README.md (limited to 'health/notifications/email/README.md') diff --git a/health/notifications/email/README.md b/health/notifications/email/README.md deleted file mode 100644 index 3470ba440..000000000 --- a/health/notifications/email/README.md +++ /dev/null @@ -1,114 +0,0 @@ - - -# 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 - - - -### 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](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.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 | -|:----|:-----------|:-------|:--------:| -| 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: `alarms@example.com` `systems@example.com`. | 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: -```conf -role_recipients_email[sysadmin]="systems@example.com" -role_recipients_email[domainadmin]="domains@example.com" -role_recipients_email[dba]="databases@example.com systems@example.com" -role_recipients_email[webmaster]="marketing@example.com development@example.com" -role_recipients_email[proxyadmin]="proxy-admin@example.com" -role_recipients_email[sitemgr]="sites@example.com" -``` - - -
- -#### Examples - -##### Basic Configuration - - - -```yaml -#------------------------------------------------------------------------------ -# email global notification options - -EMAIL_SENDER="example@domain.com" -SEND_EMAIL="YES" -DEFAULT_RECIPIENT_EMAIL="recipient@example.com" - -``` - - -## Troubleshooting - -### Test Notification - -You can run the following command by hand, to test alerts configuration: - -```bash -# 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. - - -- cgit v1.2.3