Create the Alert Configuration File min read


An alert configuration file must be created to specify where your SMTP server resides. This file also holds any configuration changes from the default for the thresholds. Here is the template of the config.yaml file. This file will be passed in using the --config-file argument demonstrated in the next step. In this case, the user is not updating any default thresholds for the alert criteria:

location:
email:
  receivers:
    - receiver@example.com
  sender: sender@example.com
  server:
    host: smtp.example.com
    port: 25
    username:
    password:

Modify this file by:

  1. Updating the host field to reflect the host of the SMTP server.

  2. Updating the port to reflect the port that your SMTP server is listening on. This port must be open and available.

  3. Updating senders and receivers details to reflect where the email will be sent to and received from.

  4. Updating the username and password if needed.

  5. Updating any default configurations for the alert thresholds (optional).

The following example file shows a configuration of an SMTP server running on an EC2 instance, sending an email to a singlestore.user Gmail user. You may add multiple recipients to the receiver list. Additionally, the user is setting custom thresholds for the leavesNotOnline, orphanDatabases and memoryCommitted checkers. Refer to the tables on the Next Steps page for the list of configurable thresholds. You can apply this change to other checkers that are based on output as well.

location:
email:
  receivers:
    - singlestore.user@gmail.com
  sender: ec2-user@ip-172-31-77-34.ec2.internal
  server:
    host: ip-172-30-77-34.ec2.internal
    port: 25
    username: 
    password:
thresholds:
  leavesNotOnline:
    fail: 2
  memoryCommitted:
    warn: 80
  orphanDatabases:
    output_level: fail