Set the relay host for SMTP

ThoughtSpot uses email to send critical notifications to ThoughtSpot Support. A relay host for SMTP traffic routes the alert and notification emails coming from ThoughtSpot through an SMTP email server.

You can configure the relay host using tscli or through the Admin Console.

ThoughtSpot Training

  • For best results in setting up ThoughtSpot emails and alerts, we recommend that you take the following ThoughtSpot U course: Email and Alert Setup.

  • See other training resources at ThoughtSpot U.

Configure using tscli

Set up SMTP rules to send critical email notifications to ThoughtSpot Support.

Set up the relay Host

To set up a relay host:

  1. Log in to the Linux shell using SSH.

  2. Issue the setup command, providing the IP address of the relay host:

    On ThoughtSpot release 6.1.1 and later, or on release 6.0.5, you can specify a custom port to connect to the relay host. If you do not specify a port, the system uses the default recommended port, port 25. Use a custom port if port 25 is blocked in your environment.

    To use the default port, run the setup command:

    $ tscli smtp set-relayhost <IP_address>

    To use a custom port instead of port 25, run the setup command, specifying the port you want to use:

     $ tscli smtp set-relayhost <IP_address>:<custom_port>

    If you are on 6.1 rather than 6.1.1, or an earlier version than 6.0.5, contact ThoughtSpot Support to use a custom port.

  3. Verify your settings:

     $ tscli smtp show-relayhost

  4. Verify that email is working.

Configure an email to send alerts

  1. Log in to the Linux shell using SSH.

  2. Specify the domain of the email address you would like emails to come from. In [email protected], this command specifies company.

     $ tscli smtp set-mailname <mailname>

  3. Specify the name of the email address you would like emails to come from. In [email protected], this command specifies example.

     $ tscli smtp set-mailfromname <mailfromname>

Configure SMTP authentication

  1. Log in to the Linux shell using SSH.

  2. If SMTP authentication is required, you must specify a username and password. Skip this step if SMTP authentication is not required.

     $ tscli smtp set-saslcredentials

Configure an email to receive alerts

ThoughtSpot sends alerts to the email address specified during installation. If you do not specify an email address, you do not receive any alerts. To add an email to receive alerts, issue the following command.

Add the ThoughtSpot Support alert email, [email protected], to allow ThoughtSpot Support to receive alerts. ThoughtSpot Support monitors these alerts to ensure your cluster’s health. Do not add this email to POC or demo environments. 
$ tscli monitoring set-config --email
     <[email protected]>,
     <your_email>

To send to multiple emails, provide a comma-separated list with no spaces.

Verify the relay with an email

Check if the email settings are working properly by using this procedure.

  1. Log in to the Linux shell using SSH.

  2. Try sending an email to yourself by issuing:

    $ echo | mail -s Hello <your_email>

  3. If you receive the email at the address(es) you supplied, email is working correctly.

Configure SMTP through the Admin Console

You can set up the relay host for SMTP from the Admin Console.

If you would like to use a custom port, rather than the default, port 25, you must configure SMTP using tscli, by running tscli smtp set-relayhost <IP_address>:<custom_port>.

Set up relay host

  1. Navigate to the Admin Console by clicking on the Admin tab from the top navigation bar. Select SMTP from the side navigation bar that appears.

    Admin Console - SMTP

  2. Select Configure.

  3. Specify the following parameters:

    Configure SMTP

    1

    Specify the relay host.
    2

    Specify the domain of the email address you would like emails to come from. In [email protected], it is company.
    3

    Specify the username of the email address you would like emails to come from. In [email protected], it is example.
    4

    If SMTP authentication is required, you must add a username and password. If you select no, you do not see the step to add a username and password.
    5

    Specify the username.
    6

    Specify the password.

  4. Click OK.

After you configure SMTP through the Admin Console, use tscli to configure an email to receive monitoring alerts and verify the relay with an email.

Was this page helpful?
×