Enable email event notifications

StackState Self-hosted v4.5.x

This page describes StackState v4.5.x. The StackState 4.5 version range is End of Life (EOL) and no longer supported. We encourage customers still running the 4.5 version range to upgrade to a more recent release.

Go to the documentation for the latest StackState release.

Overview

StackState can send an event notification by email whenever the health state of an entity or view changes. To enable email event notifications, the StackState configuration must include details of the SMTP server to use.

Configure an SMTP server to use for email event notifications

Kubernetes

1. Update the StackState configuration in values.yaml to include SMTP server details:

    stackstate:
      components:
        viewHealth:
          config: |
            stackstate{
              email {
                properties {
                  "mail.smtp.auth" = "true"   # "true" when user/pass provided   
                  "mail.smtp.starttls.enable" = "false"   # use "true" for TLS
                }
                sender = "<EMAIL_SENDER_ADDRESS>"
                server {
                  protocol = "smtp"
                  host =  "<SMTP_SERVER_HOST>"
                  port = 25
                  username = "XXX"      # optional
                  password = "XXX"      # optional
                }
              }
            }

2. Restart StackState to apply the configuration changes.

3. Use the Manage event handlers pane in the StackState UI to add an email event handler to a view.

Linux

1. Update the StackState configuration file application_stackstate.conf to include SMTP server details:

    stackstate{
      ...
   
      email {
        properties {
          "mail.smtp.auth" = "true"   # "true" when user/pass provided   
          "mail.smtp.starttls.enable" = "false"   # use "true" for TLS
        }
        sender = "<EMAIL_SENDER_ADDRESS>"
        server {
          protocol = "smtp"
          host =  "<SMTP_SERVER_HOST>"
          port = 25
          username = "XXX"      # optional
          password = "XXX"      # optional
        }
      }
   
       ...
    }

2. Restart StackState to apply the configuration changes.

3. Use the Manage Event Handlers in the StackState UI to add an email event handler to a view.

See also

• Manage Event Handlers

• Event handler functions