Configuring System Alerts

How to configure basic system alerts and add an email address for alert notifications.

  5 minute read

After setting up storage, it is recommended to configure the alert system with an email address and then customize how alerts are reported and which alerts are displayed or prioritized.

Alert Services

Alert Services are the various methods built into to TrueNAS that can notify you of a system alert. Note that some of these services are third-party services that might charge for message or data usage.

To add a new alert service, go to System > Alert Services > ADD.



Enter a Name for the alert service and select the Type. Next, decide on the severity of the alert and select an alert Level from the drop-down. Finally, enter the authentication information for the alert service. You can test the service configuration by clicking SEND TEST ALERT.

Alert Settings

To modify the default system alerts, go to System > Alert Settings.



The alerts are grouped into sections based on type. For example, alerts that are related to pools appear in the Storage alert section.

Each alert warning level and frequency can be changed. To customize alert importance, use the Warning Level drop-down. To adjust how often alert notifications are sent, use the Frequency drop-down. Setting the Frequency to NEVER prevents that alert from being added to alert notifications, but the alert will still show in the web interface if it is triggered.

To configure where alert notifications are sent, use Alert Services.

System Alerts

The alert system provides a visual warning when system conditions require administrative attention. The alert icon in the upper right corner has a notification badge that displays the total number of unread alerts.

Alert Levels

Alert icons indicate notification, warning, critical, and one-shot critical alerts. Critical messages are also emailed to the root account. One-shot critical alerts must be dismissed by the user.

Alert LevelIcon
Notification
Warning
Critical
One-shot Critical

Email

An automatic script sends a nightly email to the administrator (root) account containing important information such as the health of the disks. Alert events are also emailed to the root user account.

Scrub Task issues and S.M.A.R.T. reports are mailed separately to the address configured in those services.

The administrator typically does not read emails directly on the system. These emails are usually sent to an external email address where they can be read more conveniently. It is important to configure the system to send these emails to the administrator’s remote email account so critical issues can be quickly resolved.

The first step is to set the remote address to send system emails. Go to Accounts > Users, click   (Options) and Edit for the root user. In the Email field, enter a remote email address that is regularly monitored by the system administrator, like admin@example.com and click SAVE.

Additional configuration is done from System > Email.



Set the address the email will come from, along with the From Name. Enter the mail server address and the correct port. Select the desired security option, and enable SMTP and enter the credentials if necessary.

To use Gmail OAuth, select the option and click LOG IN TO GMAIL. Log into your gmail account as you normally would.







SMTP Authentication Settings

SettingValueDescription
Outgoing Mail Serverstring or IP addressHostname or IP address of SMTP server used for sending this email.
Mail Server PortintegerSMTP port number. Typically 25/465 (secure SMTP), or 587 (submission).
Securitydrop-down menuChoose an encryption type. Choices are Plain (No Encryption), SSL (Implicit TLS), or TLS (STARTTLS).
UsernamestringEnter the SMTP username when the SMTP server requires authentication.
PasswordstringEnter the SMTP account password if needed for authentication. Only plain text characters (7-bit ASCII) are allowed in passwords. UTF or composed characters are not allowed.

Click the SEND TEST MAIL button to verify that the configured email settings are working. If the test email fails, double-check that the Email field of the root user is correctly configured by clicking the Edit button for the root account in Accounts > Users.

SNMP

SNMP (Simple Network Management Protocol) is used to monitor network-attached devices for conditions that warrant administrative attention. TrueNAS uses Net-SNMP to provide SNMP. To configure SNMP, go to the Services page, find the SNMP row, and click (Configure).



SNMP Service Options

SettingValueDescription
LocationstringEnter the location of the system.
ContactstringEnter an email address to receive messages from the SNMP service.
CommunitystringChange from public to increase system security. Can only contain alphanumeric characters, underscores, dashes, periods, and spaces. This can be left empty for SNMPv3 networks.
SNMP v3 SupportcheckboxSet to enable support for SNMP version 3. See snmpd.conf(5) for more information about configuring this and the Authentication Type, Password, Privacy Protocol, and Privacy Passphrase fields.
UsernamestringOnly applies if SNMP v3 Support is set. Enter a username to register with this service.
Authentication Typedrop-down menuOnly applies if SNMP v3 Support is enabled. Choices are MD5 or SHA.
PasswordstringOnly applies if SNMP v3 Support is enabled. Enter and confirm a password of at least eight characters.
Privacy Protocoldrop-down menuOnly applies if SNMP v3 Support is enabled. Choices are AES or DES.
Privacy PassphrasestringEnter a separate privacy passphrase. Password is used when this is left empty.
Auxiliary ParametersstringEnter additional snmpd.conf(5) options. Add one option for each line.
Expose zilstat via SNMPcheckboxEnabling this option may have pool performance implications.
Log Leveldrop-down menuChoose how many log entries to create. Choices range from the least log entries (Emergency) to the most (Debug).
Enable Network Performance StatisticscheckboxInclude iftop network performance statistics in SNMP messages.

When starting the SNMP service, port UDP 161 is enabled to listen for SNMP requests. Available Management Information Bases (MIBs) are located in /usr/local/share/snmp/mibs. Here is a sample of the directory contents:


Last modified January 19, 2021: add tags (b90a04d6)