[Fix-17854] [Worker&SQL Task] Fix SQL task query result alert not being sent

deploy/kubernetes/dolphinscheduler/README.md

@@ -203,6 +203,9 @@ The paths above match the API and Worker server classpaths. Check the configurat
 | conf.common."resource.storage.type" | string | `"S3"` | resource storage type: HDFS, S3, OSS, GCS, ABS, NONE |
 | conf.common."resource.storage.upload.base.path" | string | `"/dolphinscheduler"` | resource store on HDFS/S3 path, resource file will store to this base path, self configuration, please make sure the directory exists on hdfs and have read write permissions. "/dolphinscheduler" is recommended |
 | conf.common."shell.kill.wait.timeout" | int | `10` | If the shell process is still active after this timeout value (in seconds), then will use kill -9 to kill it |
+| conf.common."sql.task.alert.max.content.bytes" | int | `60000` | max serialized UTF-8 bytes of the SQL task-result alert content, kept below the 65535-byte capacity of the MySQL TEXT column |
+| conf.common."sql.task.alert.max.row.value.length" | int | `100` | max chars of a single string value kept in the SQL task-result alert content, longer values are truncated with an ellipsis |
+| conf.common."sql.task.alert.max.rows" | int | `30` | max rows kept in the SQL task-result alert content, rows beyond this are replaced by an omission marker |
 | conf.common."sudo.enable" | bool | `true` | use sudo or not, if set true, executing user is tenant user and deploy user needs sudo permissions; if set false, executing user is the deploy user and doesn't need sudo permissions |
 | conf.common."support.hive.oneSession" | bool | `false` | Whether hive SQL is executed in the same session |
 | conf.common."task.resource.limit.state" | bool | `false` | Task resource limit state |

deploy/kubernetes/dolphinscheduler/values.yaml

@@ -393,6 +393,15 @@ conf:
     # -- way to collect applicationId: log, aop
     appId.collect: log
 
+    # -- max rows kept in the SQL task-result alert content, rows beyond this are replaced by an omission marker
+    sql.task.alert.max.rows: 30
+
+    # -- max chars of a single string value kept in the SQL task-result alert content, longer values are truncated with an ellipsis
+    sql.task.alert.max.row.value.length: 100
+
+    # -- max serialized UTF-8 bytes of the SQL task-result alert content, kept below the 65535-byte capacity of the MySQL TEXT column
+    sql.task.alert.max.content.bytes: 60000
+
 common:
   ## Configmap
   configmap:

docs/docs/en/architecture/configuration.md

@@ -223,6 +223,9 @@ The default configuration is as follows:
 | sudo.enable                                   | true                                             | whether to enable sudo                                                                                                                                                                                                                                                                                                                                                                                                               |
 | zeppelin.rest.url                             | http://localhost:8080                            | the RESTful API url of zeppelin                                                                                                                                                                                                                                                                                                                                                                                                      |
 | appId.collect                                 | log                                              | way to collect applicationId, if use aop, alter the configuration from log to aop, annotation of applicationId auto collection related configuration in `bin/env/dolphinscheduler_env.sh` should be removed. Note: Aop way doesn't support submitting yarn job on remote host by client mode like Beeline, and will failure if override applicationId collection-related environment configuration in dolphinscheduler_env.sh, and . |
+| sql.task.alert.max.rows                       | 30                                               | max rows kept in the SQL task-result alert content, rows beyond this are replaced by an omission marker. Takes effect after restarting Worker Server                                                                                                                                                                                                                                                                                 |
+| sql.task.alert.max.row.value.length           | 100                                              | max chars of a single string value kept in the SQL task-result alert content, longer values are truncated with an ellipsis. Takes effect after restarting Worker Server                                                                                                                                                                                                                                                              |
+| sql.task.alert.max.content.bytes              | 60000                                            | max serialized UTF-8 bytes of the SQL task-result alert content, kept below the 65535-byte capacity of the MySQL TEXT column that stores alert content. Takes effect after restarting Worker Server                                                                                                                                                                                                                                  |
 
 ### Api-server related configuration
 

docs/docs/en/guide/upgrade/incompatible.md

@@ -57,3 +57,8 @@ This document records the incompatible updates between each version. You need to
   * **Removed derived properties**: `cmdTypeIfComplement`, `complementData` (related to complement-data executions; use the detail API to obtain them)
   * To obtain any of these fields, use the detail API `GET /projects/{projectCode}/workflow-instances/{id}` instead, which continues to return the full `WorkflowInstance` object. ([#18444](https://github.com/apache/dolphinscheduler/pull/18444))
 
+## 3.5.0
+
+* `AlertSender#getAlertData` now explicitly rejects a null `alertType` by throwing `IllegalArgumentException` with an error log, instead of throwing a raw `NullPointerException`. During a rolling upgrade, **the Alert Server must be upgraded before Master/Worker**, otherwise an old Alert Server cannot recognize newly introduced `alert_type` enum values (e.g. `TASK_RESULT`) and alert delivery will fail. See the [upgrade guide](upgrade.md#rolling-upgrade-order) for details.([#18549](https://github.com/apache/dolphinscheduler/pull/18549))
+* SQL task-result alert content is size-limited: by default at most 30 rows are kept, string field values longer than 100 characters are truncated with an ellipsis, and the serialized content is bounded to 60000 UTF-8 bytes (below the 65535-byte capacity of the MySQL TEXT column); rows beyond the budget are represented by an omission marker. These defaults are tunable via `sql.task.alert.max.rows`, `sql.task.alert.max.row.value.length` and `sql.task.alert.max.content.bytes` in `common.properties` (worker restart required). ([#18549](https://github.com/apache/dolphinscheduler/pull/18549))
+

docs/docs/en/guide/upgrade/upgrade.md

@@ -75,6 +75,28 @@ Execution result:
 - After version 3.3.X and later, we only support upgrading from 3.0.0. For versions lower than this, please download the historical version and upgrade to 3.0.0.
 - After version 3.3.X and later, binary packages no longer provide plugins dependencies by default, so when you use them for the first time, you need to download and install them yourself. For more information, please refer to [Pseudo-Cluster](../installation/pseudo-cluster.md).
 
+#### Rolling Upgrade Order
+
+When performing a rolling upgrade, **the Alert Server must be upgraded before Master/Worker**.
+
+Starting from 3.5.0, the Master may persist new `alert_type` enum values (e.g. `TASK_RESULT`) into the `t_ds_alert` table. If the Alert Server has not yet been upgraded to a version that includes the new enum value, MyBatis will deserialize the unknown value as `null`, causing `AlertSender` to throw a `NullPointerException` while building the alert data. The alert will remain stuck in `WAIT_EXECUTION` and never be delivered.
+
+Upgrading in the order "Alert Server → Master → Worker" eliminates this risk.
+
+#### If the upgrade fails
+
+If the upgrade order was not followed (e.g. Master/Worker has already been upgraded before the Alert Server) and new `alert_type` values have been persisted to the `t_ds_alert` table, follow these steps to recover:
+
+1. Upgrade the Alert Server to a version that includes the new enum values and restart it. Alerts stuck in `WAIT_EXECUTION` will be picked up and delivered normally.
+2. If the Alert Server cannot be upgraded immediately, stop the old Alert Server first, then back up and clean up the affected alerts so they cannot keep blocking alert delivery:
+
+   ```sql
+   -- 1. back up the affected alerts
+   create table t_ds_alert_bak as select * from t_ds_alert where alert_type = 8;
+   -- 2. remove them from the active table
+   delete from t_ds_alert where alert_type = 8;
+   ```
+
 #### Precautions after the upgrade
 
 The alert plugin may have some dirty data. After the upgrade, clear it manually by referring to SQL.

docs/docs/zh/architecture/configuration.md

@@ -223,6 +223,9 @@ common.properties配置文件目前主要是配置hadoop/s3/yarn/applicationId
 | sudo.enable                                   | true                                             | 是否开启sudo                                                                                                                                                                                                             |
 | zeppelin.rest.url                             | http://localhost:8080                            | zeppelin RESTful API 接口地址                                                                                                                                                                                            |
 | appId.collect                                 | log                                              | 收集applicationId方式， 如果用aop方法，将配置log替换为aop，并将`bin/env/dolphinscheduler_env.sh`自动收集applicationId相关环境变量配置的注释取消掉，注意：aop不支持远程主机提交yarn作业的方式比如Beeline客户端提交，且如果用户环境覆盖了dolphinscheduler_env.sh收集applicationId相关环境变量配置，aop方法会失效 |
+| sql.task.alert.max.rows                       | 30                                               | SQL 任务结果告警内容最多保留的行数，超出的行以省略标记表示。修改后需重启 Worker Server 生效                                                                                                                                                              |
+| sql.task.alert.max.row.value.length           | 100                                              | SQL 任务结果告警内容中单个字符串字段值最多保留的字符数，超出的值以省略号截断。修改后需重启 Worker Server 生效                                                                                                                                                     |
+| sql.task.alert.max.content.bytes              | 60000                                            | SQL 任务结果告警内容序列化后的最大 UTF-8 字节数，小于存储告警内容的 MySQL TEXT 列 65535 字节容量。修改后需重启 Worker Server 生效                                                                                                                              |
 
 ## Api-server相关配置
 

docs/docs/zh/guide/upgrade/incompatible.md

@@ -56,3 +56,8 @@
   * **移除的派生属性**：`cmdTypeIfComplement`、`complementData`（补数执行相关，如需获取请使用详情接口）
   * 如需获取这些字段，请使用详情接口 `GET /projects/{projectCode}/workflow-instances/{id}`，该接口仍返回完整的 `WorkflowInstance` 对象 ([#18444](https://github.com/apache/dolphinscheduler/pull/18444))
 
+## 3.5.0
+
+* `AlertSender#getAlertData` 对 null `alertType` 增加了显式拒绝（抛 `IllegalArgumentException` 并记录错误日志），而非直接抛 `NullPointerException`。滚动升级时**必须先升级 Alert Server，再升级 Master/Worker**，否则旧 Alert Server 无法识别新增的 `alert_type` 枚举值（如 `TASK_RESULT`），会导致告警投递失败。详见[升级文档](upgrade.md#滚动升降级顺序)。([#18549](https://github.com/apache/dolphinscheduler/pull/18549))
+* SQL 任务结果告警内容有大小限制：默认最多保留 30 行，超过 100 字符的字符串字段值会被截断并以省略号标记；序列化后内容总大小限制在 60000 UTF-8 字节以内（兼容 MySQL TEXT 列 65535 字节容量），超出预算的行以省略标记对象表示。以上默认值可通过 `common.properties` 中的 `sql.task.alert.max.rows`、`sql.task.alert.max.row.value.length`、`sql.task.alert.max.content.bytes` 配置调整，修改后需重启 Worker 生效。 ([#18549](https://github.com/apache/dolphinscheduler/pull/18549))
+

docs/docs/zh/guide/upgrade/upgrade.md

@@ -76,6 +76,28 @@ jar 包 并添加到 `./tools/libs` 目录下，设置以下环境变量
 - 在 3.3.X 以及之后的版本，我们仅支持从 3.0.0 开始进行升级，低于此版本的请下载历史版本升级至 3.0.0。
 - 在 3.3.X 以及之后的版本，二进制包不再默认提供插件依赖，因此第一次使用时，需要自行下载安装。具体请参考请参照[伪集群部署(Pseudo-Cluster)](../installation/pseudo-cluster.md)
 
+#### 滚动升降级顺序
+
+在滚动升降级场景下，**必须先升级 Alert Server，再升级 Master/Worker**。
+
+从 3.5.0 起，Master 可能向 `t_ds_alert` 表写入新的 `alert_type` 枚举值（如 `TASK_RESULT`）。如果 Alert Server 尚未升级到包含该枚举值的版本，MyBatis 会将未知的枚举值反序列化为 `null`，导致 `AlertSender` 在构建告警数据时抛出 `NullPointerException`，告警将卡在 `WAIT_EXECUTION` 状态无法投递。
+
+按照"Alert Server → Master → Worker"的顺序升级可消除此风险。
+
+#### 如果升级失败
+
+如果未按上述顺序升级（例如在 Alert Server 之前先升级了 Master/Worker），且新的 `alert_type` 枚举值已写入 `t_ds_alert` 表，请按以下步骤恢复：
+
+1. 将 Alert Server 升级到包含新枚举值的版本并重启，卡在 `WAIT_EXECUTION` 状态的告警会被正常拉取并投递。
+2. 如果暂时无法升级 Alert Server，请先停止旧版 Alert Server，再备份并清理受影响告警，避免其持续阻塞告警投递：
+
+   ```sql
+   -- 1. 备份受影响告警
+   create table t_ds_alert_bak as select * from t_ds_alert where alert_type = 8;
+   -- 2. 从主表清理
+   delete from t_ds_alert where alert_type = 8;
+   ```
+
 #### 升级后的注意事项
 
 在历史版本中可能告警插件会有一些脏数据，升级后请参考一下 SQL 手动清理。

dolphinscheduler-alert/dolphinscheduler-alert-server/src/main/java/org/apache/dolphinscheduler/alert/service/AlertSender.java

@@ -100,6 +100,13 @@ public List<AlertPluginInstance> getAlertPluginInstanceList(Alert event) {
 
     @Override
     public AlertData getAlertData(Alert event) {
+        if (event.getAlertType() == null) {
+            log.error("Alert {} has null alertType, refusing to send. This indicates the Alert Server version "
+                    + "is older than the Master that created the alert. Please upgrade the Alert Server first "
+                    + "(see upgrade guide: Alert Server -> Master -> Worker).", event.getId());
+            throw new IllegalArgumentException(
+                    "Cannot build AlertData with null alertType for alert " + event.getId());
+        }
         return AlertData.builder()
                 .id(event.getId())
                 .content(event.getContent())

dolphinscheduler-alert/dolphinscheduler-alert-server/src/test/java/org/apache/dolphinscheduler/alert/runner/AlertSenderTest.java

@@ -25,6 +25,7 @@
 import static org.mockito.Mockito.when;
 
 import org.apache.dolphinscheduler.alert.api.AlertChannel;
+import org.apache.dolphinscheduler.alert.api.AlertData;
 import org.apache.dolphinscheduler.alert.api.AlertResult;
 import org.apache.dolphinscheduler.alert.config.AlertConfig;
 import org.apache.dolphinscheduler.alert.plugin.AlertPluginManager;
@@ -210,4 +211,33 @@ void testSendAlert() {
                 .thenReturn(paramsMap);
         alertSender.syncTestSend(PLUGIN_DEFINE_ID, PLUGIN_INSTANCE_PARAMS);
     }
+
+    @Test
+    void testGetAlertDataWithNullAlertType() {
+        Alert alert = new Alert();
+        alert.setId(1);
+        alert.setTitle(TITLE);
+        alert.setContent(CONTENT);
+        alert.setAlertGroupId(ALERT_GROUP_ID);
+        alert.setWarningType(WarningType.FAILURE);
+        alert.setAlertType(null);
+
+        Assertions.assertThrows(IllegalArgumentException.class,
+                () -> alertSender.getAlertData(alert));
+    }
+
+    @Test
+    void testGetAlertDataWithValidAlertType() {
+        Alert alert = new Alert();
+        alert.setId(2);
+        alert.setTitle(TITLE);
+        alert.setContent(CONTENT);
+        alert.setAlertGroupId(ALERT_GROUP_ID);
+        alert.setWarningType(WarningType.FAILURE);
+        alert.setAlertType(AlertType.TASK_RESULT);
+
+        AlertData alertData = alertSender.getAlertData(alert);
+        Assertions.assertNotNull(alertData);
+        Assertions.assertEquals(AlertType.TASK_RESULT.getCode(), alertData.getAlertType());
+    }
 }

dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/constants/Constants.java

@@ -59,6 +59,23 @@ public final class Constants {
      */
     public static final String SHELL_KILL_WAIT_TIMEOUT = "shell.kill.wait.timeout";
 
+    /**
+     * sql.task.alert.max.rows: this property defines the max rows kept in the task-result alert content.
+     */
+    public static final String SQL_TASK_ALERT_MAX_ROWS = "sql.task.alert.max.rows";
+
+    /**
+     * sql.task.alert.max.row.value.length: this property defines the max chars of a single string value kept in the
+     * task-result alert content.
+     */
+    public static final String SQL_TASK_ALERT_MAX_ROW_VALUE_LENGTH = "sql.task.alert.max.row.value.length";
+
+    /**
+     * sql.task.alert.max.content.bytes: this property defines the max serialized UTF-8 bytes of the task-result alert
+     * content.
+     */
+    public static final String SQL_TASK_ALERT_MAX_CONTENT_BYTES = "sql.task.alert.max.content.bytes";
+
     public static final String SUDO_ENABLE = "sudo.enable";
 
     public static final String RESOURCE_STORAGE_TYPE = "resource.storage.type";

dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/enums/AlertType.java

@@ -29,7 +29,7 @@ public enum AlertType {
 
     /**
      * 0 workflow instance failure, 1 workflow instance success, 2 workflow instance blocked, 3 workflow instance timeout, 4 fault tolerance warning,
-     * 5 task failure, 6 task success, 7 task timeout
+     * 5 task failure, 6 task success, 7 task timeout, 8 task result
       */
     WORKFLOW_INSTANCE_FAILURE(0, "workflow instance failure"),
     WORKFLOW_INSTANCE_SUCCESS(1, "workflow instance success"),
@@ -39,6 +39,7 @@ public enum AlertType {
     TASK_FAILURE(5, "task failure"),
     TASK_SUCCESS(6, "task success"),
     TASK_TIMEOUT(7, "task timeout"),
+    TASK_RESULT(8, "task result"),
     ;
 
     AlertType(int code, String descp) {

dolphinscheduler-common/src/main/resources/common.properties

@@ -108,3 +108,11 @@ shell.interceptor.type=bash
 
 # Whether to enable remote logging
 remote.logging.enable=false
+
+# SQL task-result alert content limits, take effect on worker server restart:
+#   sql.task.alert.max.rows: max rows kept in the alert content, default: 30
+#   sql.task.alert.max.row.value.length: max chars of a single string value kept in the alert content, default: 100
+#   sql.task.alert.max.content.bytes: max serialized UTF-8 bytes of the alert content, default: 60000
+sql.task.alert.max.rows=30
+sql.task.alert.max.row.value.length=100
+sql.task.alert.max.content.bytes=60000