Setting Up Alerts#

This guide covers how to get system alerts delivered to your inbox using SMTP and how to activate monitoring alerts for system parameters.

1. Configure an Email with SMTP access#

Configure an email service of your choice that supports SMTP, for example, MailerSend. This mailbox will be used by Juice to send alert emails.

Step A: Secure your credentials. Create a file at /etc/juice/config/smtp-email-secrets.toml. This file should only be accessible by system administrators. Store only SMTP credentials in this file.

username="smtp-username"
password="smtp-password"

Step B: Define sender settings and routing. Create smtp-email-sender-config.toml in your system configuration location(by default /etc/juice/config

sender_email="[email protected]"
default_receivers=["[email protected]"]
host="smtp.mailersend.net"
port=587
use_ssl=false
use_starttls=true
[topic_receivers]
# Optional: Add specific people for specific topics
mc_temperature=["[email protected]"]

2. Enable Parameter Monitoring Alerts#

By default, the system monitors parameters silently. To receive an email alert when a parameter (like temperature) hits a critical threshold, set the alert flag to true.

Edit parameter-monitor.toml:

[juice_topic_monitoring_units.mc_temperature]
display_label = "MC Temperature"
monitored_topic = "system-monitor.thermometry_unit_1.thermometer_5"
# ... other settings ...
warn_if_larger = 20.0e-3
alert = true  # This enables the email notification

Reference#

For more details on the technical implementation of alerting see here.