Configure Server Event Notification

A Tableau Services Manager (TSM) administrator can configure Tableau Server to allow notifications for the following events:

Content updates
- Extract failures (enabled by default)
- Subscription views for users (disabled by default)
Server health monitoring
- Server status changes (disabled by default)
- Desktop Licence reporting (disabled by default)
Drive space
- Email alerts when disk space crosses or remains below pre-configured thresholds (disabled by default)
- Recording usage history (enabled by default)

Note: You need to configure SMTP before you can configure subscriptions or notifications. For more information, see Configure SMTP Setup.

The various notification values described above can be set individually with the tsm configuration set command. Alternatively, you can construct a json file and pass all configuration values in one operation. Both methods are described in this section.

Set notification values individually

The following table shows the key/value pairs that map to the notification events described earlier in this topic. Use the tsm configuration set command with the following syntax to set a single key/value pair:

tsm configuration set -k <config.key> -v <config_value>

For example, to enable job failure notifications, run the following command:

tsm configuration set -k backgrounder.notifications_enabled -v true

Notification option	Key	Value
Extract failures or Flow run failures	`backgrounder.notifications_enabled`	`true` \| `false`
Enable subscription views for user	`subscriptions.enabled`	`true` \| `false`
Enable PDF attachments for subscriptions	`subscriptions.attachments_enabled`	`true` \| `false`
Maximum attachment size (MB) for subscription notifications	`subscriptions.max_attachment_size_megabytes`	integer value, default is `150`
Server status changes	`svcmonitor.notification.smtp.enabled`	`true` \| `false`
Licence reporting	`features.DesktopReporting`	`true` \| `false`
Remaining space thresholds: enable email notifications	`storage.monitoring.email_enabled`	`true` \| `false`
Remaining space thresholds: warning percentage	`storage.monitoring.warning_percent`	integer value, for example, `20`
Remaining space thresholds: critical percentage	`storage.monitoring.critical_percent`	integer value, for example, `15`
Set email interval	`storage.monitoring.email_interval_min`	integer value, in minutes, for example, `25`
Record usage history	`storage.monitoring.record_history_enabled`	`true` \| `false`

After you are done setting values, you must run the following command:

tsm pending-changes apply

If the pending changes require a server restart, the pending-changes apply command will display a prompt to let you know a restart will occur. This prompt displays even if the server is stopped, but in that case, there is no restart. You can suppress the prompt using the --ignore-prompt option, but this does not change the restart behaviour. If the changes do not require a restart, the changes are applied without a prompt. For more information, see tsm pending-changes apply.

Set all notification values with a single json file

To make all notifications settings with a single configuration, you can pass a json file.

Copy and edit the following template to create a file for your configuration.

{
  "configKeys": {
    "backgrounder.notifications_enabled": true,
    "subscriptions.enabled": true,
    "subscriptions.attachments_enabled": true,
    "subscriptions.max_attachment_size_megabytes": 150,
    "svcmonitor.notification.smtp.enabled": true,
    "features.DesktopReporting": true,
    "storage.monitoring.email_enabled": true,
    "storage.monitoring.warning_percent": 20,
    "storage.monitoring.critical_percent": 15,
    "storage.monitoring.email_interval_min": 25,
    "storage.monitoring.record_history_enabled": true
  }
}

After you have saved the file, pass it with the following command:

tsm settings import -f <path-to-file.json>

To apply changes, run the following command:

tsm pending-changes apply

Thanks for your feedback!

Your feedback has been successfully submitted. Thank you!

Tableau Server on Windows Help