(408) 943-4100               V   Commercial Support

Alert

  3 minute read.

Last Modified 2021-03-17 18:59 EDT

The alert system integrates with various third-party services. Tuning alerts also helps personalize TrueNAS to any highly-sensitive issues.

Alert Services

Alert Services are the various methods built into to TrueNAS that can notify you of a system alert.

Some of alert services are third-party integrations that can charge for message or data usage.

Adding a Service

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

SystemAlertServicesAdd

Name and Type

NameDescription
NameName of the new alert service.
EnabledUnset to disable this service without deleting it.
TypeChoose an alert service to display options for that service.
LevelSelect the level of severity.

Choosing a Type adds options specific to that alert service:

NameDescription
AWS RegionEnter the AWS account region.
ARNTopic Amazon Resource Name (ARN) for publishing. Example: arn:aws:sns:us-west-2:111122223333:MyTopic.
Key IDAccess Key ID for the linked AWS account.
Secret KeySecret Access Key for the linked AWS account.
NameDescription
Email AddressEnter a valid email address to receive alerts from this system.
NameDescription
HostEnter the InfluxDB hostname.
UsernameUsername for this service.
PasswordEnter password.
DatabaseName of the InfluxDB database.
SeriesInfluxDB time series name for collected points.
NameDescription
Webhook URLEnter or paste the incoming webhook URL associated with this service.
UsernameMattermost username.
ChannelName of the channel to receive notifications. This overrides the default channel in the incoming webhook settings.
Icon UrlIcon file to use as the profile picture for new messages. Example: https://mattermost.org/wp-content/uploads/2016/04/icon.png. Requires configuring Mattermost to override profile picture icons.
NameDescription
API KeyEnter or paste 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.
NameDescription
Service KeyEnter or paste the “integration/service” key for this system to access the PagerDuty API.
Client NamePagerDuty client name.
NameDescription
Webhook URLPaste the incoming webhook URL associated with this service.
NameDescription
HostnameHostname or IP address of the system to receive SNMP trap notifications.
PortUDP port number on the system receiving SNMP trap notifications. The default is 162.
SNMPv3 Security ModelEnable the SNMPv3 security model.
SNMP CommunityNetwork community string. The community string acts like a user ID or password. A user with the correct community string has access to network information. The default is public. For more information, see What is an SNMP Community String?.
NameDescription
API KeyEnter or paste the VictorOps API key.
Routing KeyEnter or paste the VictorOps routing key.

Test the service configuration by clicking SEND TEST ALERT.

Alert Settings

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

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.

Options

NameDescription
Set Warning LevelCustomizes the importance of the alert. Each level of importance has a different icon and color to express the level of importance: Info, Notice, Warning, Error, Critical (Default), Alert, and Emergency.
Set FrequencyAdjust how often alert notifications are sent. Setting the Frequency to NEVER prevents that alert from being added to alert notifications, but the alert can still show in the web interface if it is triggered. Options: Immediately (Default), Hourly, Daily, and Never.

Changing any of these options affects every configured alert service.