Apache DolphinScheduler's alerting system, powered by a sophisticated SPI plugin architecture, safeguards data workflows. Among these, email notification via the SMTP protocol serves as a vital link for timely information delivery. When the status of a workflow or task changes—whether it completes successfully, fails, or times out—the alert system responds instantly, automatically triggering an email notification to ensure relevant personnel are informed immediately. Notably, the system supports a wide range of alerting methods, including Email, DingTalk, WeChat Work, Scripts, SMS, Feishu, Slack, PagerDuty, WebexTeams, Telegram, HTTP, and Alibaba Cloud Voice, fully meeting the diverse needs of different scenarios and users. Email, DingTalk, WeChat Work, Scripts, SMS, Feishu, Slack, PagerDuty, WebexTeams, Telegram, HTTP, and Alibaba Cloud Voice This article focuses deeply on Email alerts, presenting a comprehensive guide to setup and usage. It covers everything from creating an Email alert instance and fine-tuning SMTP parameters to building alert groups and linking them with workflows. Additionally, it provides an in-depth analysis of the mail delivery mechanism, shares practical best practices, and offers troubleshooting methods for common issues to help you master and efficiently use the Email alert feature. Core Architecture The Email alert system consists of the following core components: AlertChannelFactory: Defines the parameters and creation logic for the email alert plugin.
MailSender: Implements the actual email sending functionality.
AlertGroupService: Manages CRUD operations for alert groups.
AlertPluginInstanceService: Manages alert plugin instances. AlertChannelFactory: Defines the parameters and creation logic for the email alert plugin. AlertChannelFactory MailSender: Implements the actual email sending functionality. MailSender AlertGroupService: Manages CRUD operations for alert groups. AlertGroupService AlertPluginInstanceService: Manages alert plugin instances. AlertPluginInstanceService Setup Steps Step 1: Create an Email Alert Instance Log in to the DolphinScheduler Web UI.
Navigate to "Security" -> "Alert Instance Management."
Click "Create Alert Instance." Log in to the DolphinScheduler Web UI. Navigate to "Security" -> "Alert Instance Management." Click "Create Alert Instance." Select "Email" as the alert plugin type. Select "Email" as the alert plugin type. The Email alert instance requires the following key parameters: key parameters Parameter

Description

Required

Example



server

SMTP server address

Yes

smtp.gmail.com



port

SMTP port

Yes

587



sender

Sender email address

Yes

noreply@example.com



user

SMTP auth username

Yes

user@example.com



password

SMTP auth password

Yes

yourpassword



enableSmtpAuth

Enable SMTP authentication

Yes

true



enableTls

Enable TLS encryption

No

true



enableSsl

Enable SSL encryption

No

false



receivers

Recipient list

Yes

admin@example.com Parameter

Description

Required

Example



server

SMTP server address

Yes

smtp.gmail.com



port

SMTP port

Yes

587



sender

Sender email address

Yes

noreply@example.com



user

SMTP auth username

Yes

user@example.com



password

SMTP auth password

Yes

yourpassword



enableSmtpAuth

Enable SMTP authentication

Yes

true



enableTls

Enable TLS encryption

No

true



enableSsl

Enable SSL encryption

No

false



receivers

Recipient list

Yes

admin@example.com Parameter

Description

Required

Example Parameter Parameter Description Description Required Required Example Example server

SMTP server address

Yes

smtp.gmail.com server server SMTP server address SMTP server address Yes Yes smtp.gmail.com smtp.gmail.com port

SMTP port

Yes

587 port port SMTP port SMTP port Yes Yes 587 587 sender

Sender email address

Yes

noreply@example.com sender sender Sender email address Sender email address Yes Yes noreply@example.com noreply@example.com noreply@example.com user

SMTP auth username

Yes

user@example.com user user SMTP auth username SMTP auth username Yes Yes user@example.com user@example.com user@example.com password

SMTP auth password

Yes

yourpassword password password SMTP auth password SMTP auth password Yes Yes yourpassword yourpassword enableSmtpAuth

Enable SMTP authentication

Yes

true enableSmtpAuth enableSmtpAuth Enable SMTP authentication Enable SMTP authentication Yes Yes true true enableTls

Enable TLS encryption

No

true enableTls enableTls Enable TLS encryption Enable TLS encryption No No true true enableSsl

Enable SSL encryption

No

false enableSsl enableSsl Enable SSL encryption Enable SSL encryption No No false false receivers

Recipient list

Yes

admin@example.com receivers receivers Recipient list Recipient list Yes Yes admin@example.com admin@example.com admin@example.com Step 2: Create an Alert Group An alert group is a collection of alert instances used to manage multiple alert channels uniformly: Navigate to "Security" -> "Alert Group Management."
Click "Create Alert Group."
Enter the alert group name and description.
Select the Email alert instance created earlier.
Save the configuration. Navigate to "Security" -> "Alert Group Management." Click "Create Alert Group." Enter the alert group name and description. Select the Email alert instance created earlier. Save the configuration. Step 3: Link to Workflow Associate the alert group with a workflow definition: Go to the "Workflow Definition" page.
Select or create a workflow.
Configure the alert group in the workflow settings.
Save the workflow definition. Go to the "Workflow Definition" page. Select or create a workflow. Configure the alert group in the workflow settings. Save the workflow definition. Mail Sending Implementation The core logic for sending emails is implemented in the MailSender class: MailSender // Main steps for sending email
1. Create an SMTP session
2. Configure mail server parameters
3. Construct email content
4. Send the email
5. Handle the delivery results // Main steps for sending email
1. Create an SMTP session
2. Configure mail server parameters
3. Construct email content
4. Send the email
5. Handle the delivery results The system supports HTML email templates for better readability. Alert Trigger Scenarios Email alerts are automatically triggered in the following scenarios: Workflow Success: When the workflow execution finishes.
Workflow Failure: When the workflow execution fails.
Task Failure: When a task node execution fails.
Workflow Timeout: When the workflow execution exceeds the time limit.
SQL Task Results: Sending SQL query results (requires extra configuration). Workflow Success: When the workflow execution finishes. Workflow Success Workflow Failure: When the workflow execution fails. Workflow Failure Task Failure: When a task node execution fails. Task Failure Workflow Timeout: When the workflow execution exceeds the time limit. Workflow Timeout SQL Task Results: Sending SQL query results (requires extra configuration). SQL Task Results SQL Task Email Delivery SQL tasks support sending query results via email; the following parameters need to be configured: sendEmail: Enable email notification.
title: Email subject.
groupId: Alert group ID. sendEmail: Enable email notification. sendEmail title: Email subject. title groupId: Alert group ID. groupId Best Practices 1. Security Configuration Use TLS or SSL encryption to ensure secure transmission.
Regularly update SMTP authentication passwords.
Limit the recipient scope to prevent information leakage. Use TLS or SSL encryption to ensure secure transmission. Regularly update SMTP authentication passwords. Limit the recipient scope to prevent information leakage. 2. Performance Optimization Set reasonable SMTP connection timeouts.
Avoid sending massive volumes of alert emails during peak hours.
Use mail queuing mechanisms to prevent blocking. Set reasonable SMTP connection timeouts. Avoid sending massive volumes of alert emails during peak hours. Use mail queuing mechanisms to prevent blocking. 3. Monitoring and Maintenance Periodically test the email sending functionality.
Monitor alert delivery success rates.
Establish backup notification mechanisms for failed email deliveries. Periodically test the email sending functionality. Monitor alert delivery success rates. Establish backup notification mechanisms for failed email deliveries. Troubleshooting Common Issues Email Sending Failed Check if SMTP server configurations are correct.
Verify that authentication credentials are valid.
Confirm network connectivity.
Check AlertServer logs for detailed error messages. Check if SMTP server configurations are correct. Verify that authentication credentials are valid. Confirm network connectivity. Check AlertServer logs for detailed error messages. Email Format Abnormal Check the email template configuration.
Verify the recipient email format.
Confirm the email content encoding settings. Check the email template configuration. Verify the recipient email format. Confirm the email content encoding settings. Alert Not Triggered Confirm the alert group is correctly linked to the workflow.
Check the workflow alert settings.
Verify the status of the AlertServer service. Confirm the alert group is correctly linked to the workflow. Check the workflow alert settings. Verify the status of the AlertServer service. Summary DolphinScheduler’s Email alert feature provides a complete workflow monitoring and notification mechanism. By properly configuring alert instances, groups, and workflow associations, you can ensure timely access to system status information. It is recommended to combine this with other alert channels (like DingTalk or WeChat) in production to build a robust monitoring system. Notes This document is based on DolphinScheduler’s SPI plugin architecture. Email alerting is a built-in plugin. The system supports custom extensions; for development, please refer to the GitHub Alert SPI documentation at: docs/docs/en/contribute/backend/spi/alert.md. docs/docs/en/contribute/backend/spi/alert.md

This story contains AI-generated text. The author has used AI either for research, to generate outlines, or write the text itself. 

PagerDuty

Apache

Slack

Apache DolphinScheduler Email Alert Setup Guide for Enterprise Needs

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

A 10-Minute Deep Dive Into the Core Architecture of Apache SeaTunnel and DataX

How to Seamlessly Transfer From Airflow to Apache DolphinScheduler With Air2phin

A Comprehensive Guide to Building DolphinScheduler 3.2.0 Production-Grade Cluster Deployment

How to Regularly Delete Log Instances in DolphinScheduler

How to Enable Auto-Start for Apache DolphinScheduler

Solutions for Upgrading Apache DolphinScheduler from Version 1.3.4 to 3.1.2

A 10-Minute Deep Dive Into the Core Architecture of Apache SeaTunnel and DataX

How to Seamlessly Transfer From Airflow to Apache DolphinScheduler With Air2phin

A Comprehensive Guide to Building DolphinScheduler 3.2.0 Production-Grade Cluster Deployment

How to Regularly Delete Log Instances in DolphinScheduler

How to Enable Auto-Start for Apache DolphinScheduler

Solutions for Upgrading Apache DolphinScheduler from Version 1.3.4 to 3.1.2

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps