Skip to main content
Version: 2.6

Configure email notifications

Data Migrator supports sending email notifications whenever certain events occur, such as when a migration stops or falls behind filesystem events.

note

Email notifications are disabled for trial licenses. To start using this feature, Upgrade to a full license

To use email notifications:

  1. Configure an SMTP server to send the emails.
  2. Subscribe to notification types.

Configure an SMTP server with the UI​

Configure an SMTP server in the UI by accessing the SMTP configuration tab and filling in the necessary fields.

  1. Select the Data Migrator instance name (for example, "LDM-localhost") on the Dashboard to access the overview page.
  2. Under the configuration category on the left, select SMTP Settings.
  3. Fill in the form.
  4. Select Save.

SMTP server configuration fields​

  • SMTP Email Server (Required): The host domain or IP address of your SMTP server.
  • SMTP Connection Security (Required): The type of security your SMTP server uses. Can be TLS, StartTLS Enabled & Required, StartTLS Enabled, or None.
    • TLS: Immediately uses a secure SMTPS connection. If the secure connection fails, the connection attempt ends.
    • StartTLS Enabled & Required: Starts using an unsecured connection and tries to upgrade to a secure connection. If the secure connection fails, the connection attempt ends.
    • StartTLS Enabled: Starts using an unsecured connection and tries to upgrade to a secure connection. If the secure connection fails, an unsecured connection is used instead.
    • None: Uses an unsecured connection.
  • SMTP Port (Required): The port used to connect to the SMTP server.
  • Use Authentication: Optional field. Enables the provision of a username and password for authenticating with the SMTP server.
  • SMTP Username: The username to use for authenticating with the SMTP server. Requires Use Authentication to be enabled.
  • SMTP Password: The password to use for authenticating with the SMTP server. Requires Use Authentication to be enabled.
  • Sender Email Address (Required): The email address to use with any emails automatically sent by Data Migrator from the SMTP server.
  • Email Subject Prefix (Required): Text that will automatically precede the subject of any email sent by Data Migrator from the SMTP server. This can be used to easily identify these emails in the inbox.

Once you've saved the form and the SMTP server is configured, you can configure email notifications with the UI.

Configure email notifications with the UI​

Set up email notifications in the UI by accessing the Email Notifications tab and filling in the necessary fields.

  1. Select the product name (for example, "LDM-localhost") on the Dashboard to access the overview page (or continue from configuring an SMTP server in the UI).
  2. Under the configuration category on the left, select Email Notifications.
  3. Enter the Recipient email address you want to send notifications to.
  4. Opt into the event notifications you want to receive.
  5. Select Save.

Select Send A Test Email to send a test notification email to the specified address. If you receive an email with the text "This is a test email notification" and a list of email addresses subscribed to notifications, you've configured email notifications correctly.

Email notification types​

  • Select all: Select this checkbox to enable all available notifications.
info

Additional email notification types can be added using the notification email types show and notification email types add CLI commands. See the email notification type reference for more information on the types available.

Filesystems​

  • A filesystem has become unhealthy: Any time a filesystem enters an unhealthy state.

Data transfer agents​

  • A data transfer agent is unhealthy: When the status of a data transfer agent has changed to unhealthy due to a connection error or other problem.
  • Couldn't reconnect to a data transfer agent: When Data Migrator restarts and is unable to reconnect with one or more data transfer agents.
  • No data transfer agents are available: When data transfer has stopped because no data transfer agents are available.

LiveData Migrator​

  • Data Migrator is falling behind system events: When it is detected that the number of events (changes to data) occurring on a source filesystem is too rapid for a migration to keep up with over a given period of time. The email will contain the migration name, the filesystem ID, and simple statistics about the events. The sensitivity of this notification is configurable.

Backup and Restore​

  • Backup status: Notifies you whether a backup operation is successful or failed.
  • Restore from backup status: Notifies you whether a restore operation is successful or failed.

Migrations​

  • Data migration has stopped: Any time a migration automatically stops informing you of the migration's name and the exception message that caused the migration to terminate.
  • Data migration is missing events: When Data Migrator doesn't receive the expected number of events in a migration, and fails to retry querying them 10 times.
  • Files are failing to migrate: A file fails to transfer in a migration. The notification includes a link to the failed migration.
  • Retry occurred: Data Migrator tried transferring failed files more than once.

Migration Verification​

  • Migration verification started: These notifications are sent when a verification scan has been initiated.
  • Migration verification complete: These notifications are sent when a verification scan is completed, outlining any inconsistencies detected.

For more information, see Verify migrations