Configure Email Server

Observability can be configured to use an email server that implements the Simple Mail Transfer Protocol (SMTP), like Amazon Simple Email Service (SES), Azure Communication Services, or Google Workspace SMTP Relay Service.

This enables the email alert feature in Observability for rule-based notifications.

Prerequisites

• Observability instance installed using dk-installer.exe, as outlined in Install on Windows, or dk-installer, as outlined in Install on Mac/Linux or Install Enterprise.
• Credentials for an SMTP email server: host, port, username, password, and sender email address.

Configure SMTP credentials

1. Navigate to the directory that contains the obs-docker-compose.yml file for Observability.

   • If the instance was installed using dk-installer.exe, the file can be located under "AppData\Local\DataKitchenApps".
   • If the instance was installed using dk-installer, the file can be located in the folder from which the Python installer was executed.

2. Add the following lines with appropriate values under the services > observability_backend > environment section.

   services:
    ...
    observability_backend:
      ...
      environment:
        SMTP_ENDPOINT: <host>
        SMTP_PORT: <port>
        SMTP_USER: <username>
        SMTP_PASSWORD: <password>
        SMTP_FROM_ADDRESS: <sender email address>
   

3. Restart the application.

   docker compose -f obs-docker-compose.yml up -d --wait