Get a Quote     (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Alert Services Screens

  5 minute read.

Last Modified 2022-06-27 12:58 EDT

The Alert Services screen has options to create and edit alert services.

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 Alert Service Screen

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.

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 level of severity from the dropdown list. Options are Info, Notice, Warning, Error, Critical, Alert or Emergency.

AWS SNS 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.

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

Cancel exist to the Alert Services screen without saving.

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

Email Authentication Settings

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

AddAlertServiceEmailScreen

Authentication Settings

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

InfluxDB Authentication Settings

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 name for the InfluxDB time series name for collected points.

MatterMost Authentication Settings

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

AddAlertServiceMattermostScreen

Authentication Settings

SettingDescription
Webhoot URLEnter or past the incoming webhook URL assoicated with this service.
UsernameEnter the Mattermost user name.
ChannelEnter the name of the channel to receive notifications. This overrides the default channel in the incoming webhot 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 Authentication Settings

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 Authentication Settings

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 Authentication Settings

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

AddAlertServiceSlackScreen

Authentication Settings

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

SNMP Trap Authentication Settings

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

AddAlertServiceSNMPTrapScreen

Authentication Settings

SettingDescription
HostnameEnter the host name 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 has access to network information. the default is public. For more information, see What is an SNMP Community String?.

Telegram Authentication Settings

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 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 Authentication Settings

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.

Edit Alert Service Screen

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 drop down list for an alert service to display options for that service. Options are AWS SNS, E-Mail, InfluxDB, Mattermost, OpsGenie, PagerDuty, Slack, SNMP Trap, Telegram or VictorOPS.
LevelSelect the level of severity from the dropdown list. Options are Info, Notice, Warning, Error, Critical, Alert or Emergency.

Authentication Settings

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

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

Cancel exist to the Alert Services screen without saving.

Use Save to keep any changes made.

Related Content