TrueNAS SCALETrueNAS Nightly Development Documentation
This content follows experimental nightly development software. Pre-release software is intended for testing purposes only.
Use the Product and Version selectors above to view content specific to a stable software release.

Alert Settings Screen

The Alert Settings screen displays options to create and edit alert services and to configure warning levels and frequencies. To access this screen, click the notifications icon, then click the settings icon and select Alert Settings on the dropdown list.

AlertServicesScreen

Use Columns to change the information displayed in the list of alert services. Options are Unselect All, Type, Level, Enabled and Reset to Defaults.

Add/Edit Alert Service Screen

The Add Alert Service and Edit Alert Service screens show the same settings.

Use Add to create a new alert service using the Add Alert Service screen. The Type settings for AWS SNS display by default. To add an alert service for another option, use the Type dropdown list. Only the Authentication Settings change for each option.

Use the Edit Alert Service screen to modify settings for a service. Select the more_vert icon for the service, and then click Edit to display the Edit Alert Service screen.

AddAlertServiceScreen

Name and Type Settings

SettingDescription
NameEnter a name for the new alert service.
EnabledClear the checkmark to disable this service without deleting it.
TypeSelect an option from the dropdown list for an alert service to display options for that service. Options are AWS SNS which is the default type displayed, E-Mail, InfluxDB, Mattermost, OpsGenie, PagerDuty, Slack, SNMP Trap, Telegram or VictorOPS.
LevelSelect the severity from the dropdown list. Options are Info, Notice, Warning, Error, Critical, Alert or Emergency.
TrueNAS SCALE sends alert notifications for all warnings matching and above the selected level. For example, a warning level set to Critical triggers notifications for Critical, Alert, and Emergency level warnings.

Use SEND TEST ALERT to generate a test alert to confirm the alert service works.

Click Cancel to exit the Alert Services screen without saving.

Use Save to add the new service with the settings you specify to the list of alert services.

Alert Service Types

AWS SNS

Click here for more information

Select AWS SNS from the Type dropdown list to display AWS SNS authentication settings.

AddAlertServiceScreen

Authentication Settings

SettingDescription
AWS RegionEnter the AWS account region.
ARNTopic Amazon Resource Name (ARN) for publishing. For example, arn:aws:sns:us-west-2:111122223333:MyTopic.
Key IDEnter the access key ID for the linked AWS account.
Secret KeySecret access key for the linked AWS account.

Email

Click here for more information

Select Email from the Type dropdown list to display email authentication settings.

AddAlertServiceEmailScreen

Authentication Settings

SettingDescription
Email AddressEnter a valid email address to receive alerts from this TrueNAS system.

InfluxDB

Click here for more information

Select InfluxDB from the Type dropdown list to display InfluxDB authentication settings.

AddAlertServiceInfluxDBScreen

Authentication Settings

SettingDescription
HostEnter the InfluxDB host name.
UsernameEnter the user name for this service.
PasswordEnter the password for the user on this service
DatabaseEnter the name of the InfluxDB database.
SeriesEnter the InfluxDB time series name for collected points.

MatterMost

Click here for more information

Select Mattermost from the Type dropdown list to display Mattermost authentication settings.

AddAlertServiceMattermostScreen

Authentication Settings

SettingDescription
Webhook URLEnter or past the incoming webhook URL associated with this service.
UsernameEnter the Mattermost user name.
ChannelEnter the name of the channel to receive notifications. Entering a channel overrides the default channel in the incoming webhook settings.
Icon URLEnter the icon file to use as the profile picture for new messages. For example, https://mattermost.org/wp-content/uploads/2016/04/icon.png. Requires configuring Mattermost to override profile picture icons.

OpsGenie

Click here for more information

Select OpsGenie from the Type dropdown list to display OpsGenie authentication settings.

AddAlertServiceOpsGenieScreen

Authentication Settings

SettingDescription
API KeyEnter the API key. Find the API key by signing into the OpsGenie web interface and going to Integrations/Configured Integrations. Click the desired integration, Settings, and read the API Key field.
API URLLeave empty for default (OpsGenie API).

PagerDuty

Click here for more information

Select PagerDuty from the Type dropdown list to display PagerDuty authentication settings.

AddAlertServicePagerDutyScreen

Authentication Settings

SettingDescription
Service KeyEnter or paste the integration/service key for this system to access the PagerDuty API.
Client NameEnter the PagerDuty client name.

Slack

Click here for more information

Select Slack from the Type dropdown list to display Slack authentication settings.

AddAlertServiceSlackScreen

Authentication Settings

SettingDescription
Webhook URLPaste the incoming webhook URL associated with this service.

SNMP Trap

Click here for more information

Select SNMP Trap from the Type dropdown list to display SNMP trap authentication settings.

AddAlertServiceSNMPTrapScreen

Authentication Settings

SettingDescription
HostnameEnter the hostname or IP address of the system to receive SNMP trap notifications.
PortEnter the UDP port number on the system receiving SNMP trap notifications. The default is 162.
SNMPv3 Security ModelSelect to enable the SNMPv3 security model.
SNMP CommunityEnter the network community string. The community string acts like a user ID or password. A user with the correct community string can access network information. The default is public. For more information, see What is an SNMP Community String?.

Telegram

Click here for more information

Select Telegram from the Type dropdown list to display Telegram authentication settings.

AddAlertServiceTelegramScreen

Authentication Settings

SettingDescription
Bot API TokenEnter the Telegram Bot API Token How to create a Telegram Bot.
List of chat IDsEnter a list of chat IDs separated by a space ( ), comma (,), or semicolon (;). To find your chat ID, send a message to the bot, group, or channel and visit https://core.telegram.org/bots/api#getting-updates.

VictorOPS

Click here for more information

Select VictorOps from the Type dropdown list to display VictorOps authentication settings.

AddAlertServiceVictorOpsScreen

Authentication Settings

SettingDescription
API KeyEnter or paste the VictorOps API key.
Routing KeyEnter or past the VictorOps routing key.

Alert Categories

Use the Category dropdown list to display alert settings for each category.

Applications

Applications alert settings display by default. These alerts apply to the third-party applications you deploy on your TrueNAS system.

Click here for more information

AlertSettingsApplications

You can customize alert settings for when available applications have updates, catalog is not healthy, the system cannot configure or start applications, and the system cannot sync the catalog.

Certificates

Certificates alert settings apply to certificates you add through the Credentials > Certificates screen.

Click here for more information

AlertSettingsCertificates

You can customize alert settings for when a certificate expires, a certificate parsing fails, a certificate revokes, and the web UI HTTPS certificate setup fails.

Directory Service

Directory Service alert settings apply to the Active Directory and LDAP servers configured on your TrueNAS.

Click here for more information

AlertSettingsDirectoryServices

You can customize alert settings for when the Active Directory bind is unhealthy, Active Directory domain validation fails, the domain is offline, and the LDAP bind bind is unhealthy.

High Availability Settings

TrueNAS Enterprise

This section only applies to TrueNAS Enterprise hardware.

High Availability alert settings apply to TrueNAS Enterprise HA systems and only displays on the list of alerts for dual-controller High-Availability systems with an Enterprise license applied.

Click here for more information

AlertSettingsHA1

AlertSettingsHA2

You can customize alert settings for when an automatic sync to peer fails, disks are missing on the active and/or standby controller, the system fails to check failover status with the other controller, syncing operations fail such as encryption keys to peer and KMIP keys to peer, the failover interface is not found, and when a failover action fails.

Hardware

Hardware alert settings apply to the IPMI network connections, and S.M.A.R.T. and smartd that monitors the hard drives installed on your TrueNAS system.

Click here for more information

AlertSettingsHardware

You can customize alert settings for when disk(s) format with the data integrity feature, IPMI has system events, the IPMI system event log space is low, S.M.A.R.T. has an error, and smartd is not running.

The IPMI System Event Log (SEL) stores system events and can assist with debugging hardware issues. Review IPMI SEL alerts and resolve any underlying hardware issues before clearing space in the SEL. Consult manufacturer documentation for your motherboard to learn how to review IPMI system events and clear the log.

Key Management Interoperability Protocol (KMIP)

Key Management Interoperability Protocol (KMIP) alert settings only apply to KMIP configured on a TrueNAS Enterprise system.

Click here for more information

AlertSettingsKMIP

You can customize alert settings for when the system fails to communicate, sync the SED global password, and sync keys with the KMIP server.

Plugins

Plugins alert settings apply to plugins installed on your TrueNAS.

Click here for more information

AlertSettingsPlugins

You can customize the alert setting for when plugin updates are available.

Network

Network alert settings apply to network interfaces configured on your TrueNAS.

Click here for more information

AlertSettingsNetwork

You can customize alert settings for when ports are not active on the LAGG interface and when the LAGG interface has no active ports.

Reporting

Reporting alert settings apply to netdata, database size threshold, and syslog processes on your TrueNAS.

Click here for more information

AlertSettingsReporting

You can customize alert settings for when netdata has critical alerts and warnings, the reporting database size exceeds the threshold, and syslog-ng is not running.

Sharing

Sharing alert settings apply to iSCSI, NFS, or SMB shares and connections configured on your TrueNAS.

Click here for more information

AlertSettingsSharing

You can customize alert settings for when a deprecated service is running, IP addresses bound to an iSCSI portal are not found, NFS services cannot bind to specific IP addresses using 0.0.0.0, and the system cannot resolve NFS share references hosts.

You can also customize alerts for when NTLMv1 attempts authentication in the last 24 hours, SMB1 connections to TrueNAS server are performed in the last 24 hours, and a share is unavailable because it uses a locked dataset.

Storage

Storage alert settings apply to quotas, pools, snapshots, and scrub processes on your TrueNAS.

Click here for more information

AlertSettingsStorage1

AlertSettingsStorage2

You can customize alert settings for when a dataset exceeds standard and critical quotas, a pool has new available feature flags, pool space usage exceeds 70, 80, or 90 percent, and pool status is not healthy.

You can change alert settings for when a pool consumes USB disks, a scrub pauses, and too many snapshots exist.

System

System alert settings apply to system processes, the system dataset, TrueCommand API Key, SSH logins, system reboots, updates, and the web interface.

Click here for more information

AlertSettingsSystem1

AlertSettingsSystem2

You can customize alert settings for when the admin user is overridden, the boot pool is unhealthy, the system dataset has core files, a device slows down pool I/O, NTP health checks fail, and TrueCommand API keys are disabled or need confirmation.

You can also change alert settings for when SSH logins fail, the system is not ready for Kdump, the web UI cannot bind to a configured address, TrueCommand fails health checks, the system reboots off schedule, and update are available, failed, or not applied.

Tasks

Tasks alert settings apply to cloud sync, VMWare snapshots, replication, rsync, scrub and snapshot tasks scheduled on your TrueNAS.

Click here for more information

AlertSettingsTasks1

AlertSettingsTasks2

You can customize alert settings for when cloud sync tasks, VMWare snapshot creation, login, and deletion, replication, rsync tasks, scrubs, and snapshot tasks fail in general or due to locked datasets.

You can also change alert settings for when replication, rsync tasks, and scrubs succeed.

UPS

UPS alert settings apply to a UPS connected to your TrueNAS.

Click here for more information

AlertSettingsUPS

You can customize alert settings for when the UPS battery is low or needs replacement, the UPS establishes or loses communication, and the UPS is on battery or line power.

Alert Warning Levels

Use the Set Warning Level dropdown list to customize alert importance. Each warning level has an icon and color to express the level of urgency.

To make the system email you when alerts with a specific warning level trigger, set up an email alert service with that warning level. TrueNAS SCALE sends alert notifications for all warnings matching and above the selected level For example, a warning level set to Critical triggers notifications for Critical, Alert, and Emergency level warnings.

LevelIconAlert Notification?
INFOAlertLevelInfoNoticeAlertEmergencyNo
NOTICEAlertLevelInfoNoticeAlertEmergencyYes
WARNINGAlertLevelWarningYes
ERRORAlertLevelErrorCriticalYes
CRITICALAlertLevelErrorCriticalYes
ALERTAlertLevelInfoNoticeAlertEmergencyYes
EMERGENCYAlertLevelInfoNoticeAlertEmergencyYes

Alert Frequency

Use the Set Frequency dropdown list to adjust how often the system sends or displays alert notifications.

Alert frequency options are Immediately (Default), Hourly, Daily or Never. Setting the Frequency to Never prevents that alert from displaying in the Alerts Notification dialog, but it still pops up in the web UI if triggered.