[Improvement][alert] Add configurable timeout for script alert plugin (#18034)

asadjan4611 · asadjan4611 · commit f3ed01dfb388 · 2026-03-11T14:36:07.000+05:00
diff --git a/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtils.java b/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtils.java
@@ -18,6 +18,7 @@
 package org.apache.dolphinscheduler.plugin.alert.script;
 
 import java.io.IOException;
+import java.util.concurrent.TimeUnit;
 
 import lombok.extern.slf4j.Slf4j;
 
@@ -29,12 +30,13 @@ private ProcessUtils() {
     }
 
     /**
-     * executeScript
+     * executeScript with timeout
      *
+     * @param timeoutSeconds timeout in seconds, if <= 0 waits indefinitely
      * @param cmd cmd params
-     * @return exit code
+     * @return exit code, -1 if error, -2 if timeout
      */
-    static Integer executeScript(String... cmd) {
+    static Integer executeScript(long timeoutSeconds, String... cmd) {
 
         int exitCode = -1;
 
@@ -46,7 +48,16 @@ static Integer executeScript(String... cmd) {
 
             inputStreamGobbler.start();
             errorStreamGobbler.start();
-            return process.waitFor();
+
+            boolean finished = process.waitFor(timeoutSeconds, TimeUnit.SECONDS);
+            if (!finished) {
+                log.error("script execution timed out after {} seconds, destroying process", timeoutSeconds);
+                process.destroyForcibly();
+                inputStreamGobbler.interrupt();
+                errorStreamGobbler.interrupt();
+                return -2;
+            }
+            return process.exitValue();
         } catch (IOException | InterruptedException e) {
             log.error("execute alert script error {}", e.getMessage());
             Thread.currentThread().interrupt();
diff --git a/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptAlertChannelFactory.java b/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptAlertChannelFactory.java
@@ -21,10 +21,12 @@
 import org.apache.dolphinscheduler.alert.api.AlertChannelFactory;
 import org.apache.dolphinscheduler.alert.api.AlertInputTips;
 import org.apache.dolphinscheduler.common.utils.JSONUtils;
+import org.apache.dolphinscheduler.spi.params.base.DataType;
 import org.apache.dolphinscheduler.spi.params.base.ParamsOptions;
 import org.apache.dolphinscheduler.spi.params.base.PluginParams;
 import org.apache.dolphinscheduler.spi.params.base.Validate;
 import org.apache.dolphinscheduler.spi.params.input.InputParam;
+import org.apache.dolphinscheduler.spi.params.input.number.InputNumberParam;
 import org.apache.dolphinscheduler.spi.params.radio.RadioParam;
 
 import java.util.Arrays;
@@ -66,7 +68,17 @@ public List<PluginParams> params() {
                 .addValidate(Validate.newBuilder().setRequired(true).build())
                 .build();
 
-        return Arrays.asList(scriptUserParam, scriptPathParam, scriptTypeParams);
+        InputNumberParam scriptTimeoutParam =
+                InputNumberParam.newBuilder(ScriptParamsConstants.NAME_SCRIPT_TIMEOUT,
+                        ScriptParamsConstants.SCRIPT_TIMEOUT)
+                        .setValue(ScriptParamsConstants.DEFAULT_SCRIPT_TIMEOUT)
+                        .addValidate(Validate.newBuilder()
+                                .setType(DataType.NUMBER.getDataType())
+                                .setRequired(false)
+                                .build())
+                        .build();
+
+        return Arrays.asList(scriptUserParam, scriptPathParam, scriptTypeParams, scriptTimeoutParam);
     }
 
     @Override
diff --git a/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptParamsConstants.java b/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptParamsConstants.java
@@ -31,6 +31,12 @@ public final class ScriptParamsConstants {
 
     static final String NAME_SCRIPT_USER_PARAMS = "userParams";
 
+    static final String SCRIPT_TIMEOUT = "$t('timeout')";
+
+    static final String NAME_SCRIPT_TIMEOUT = "timeout";
+
+    static final int DEFAULT_SCRIPT_TIMEOUT = 60;
+
     private ScriptParamsConstants() {
         throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
     }
diff --git a/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSender.java b/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSender.java
@@ -36,6 +36,7 @@ public final class ScriptSender {
     private final String scriptPath;
     private final String scriptType;
     private final String userParams;
+    private final long timeout;
 
     ScriptSender(Map<String, String> config) {
         scriptPath = StringUtils.isNotBlank(config.get(ScriptParamsConstants.NAME_SCRIPT_PATH))
@@ -47,6 +48,9 @@ public final class ScriptSender {
         userParams = StringUtils.isNotBlank(config.get(ScriptParamsConstants.NAME_SCRIPT_USER_PARAMS))
                 ? config.get(ScriptParamsConstants.NAME_SCRIPT_USER_PARAMS)
                 : "";
+        timeout = StringUtils.isNotBlank(config.get(ScriptParamsConstants.NAME_SCRIPT_TIMEOUT))
+                ? Long.parseLong(config.get(ScriptParamsConstants.NAME_SCRIPT_TIMEOUT))
+                : ScriptParamsConstants.DEFAULT_SCRIPT_TIMEOUT;
     }
 
     AlertResult sendScriptAlert(String title, String content) {
@@ -108,13 +112,19 @@ private AlertResult executeShellScript(String title, String content) {
 
         String[] cmd = {"/bin/sh", "-c", scriptPath + ALERT_TITLE_OPTION + "'" + title + "'" + ALERT_CONTENT_OPTION
                 + "'" + content + "'" + ALERT_USER_PARAMS_OPTION + "'" + userParams + "'"};
-        int exitCode = ProcessUtils.executeScript(cmd);
+        int exitCode = ProcessUtils.executeScript(timeout, cmd);
 
         if (exitCode == 0) {
             alertResult.setSuccess(true);
             alertResult.setMessage("send script alert msg success");
             return alertResult;
         }
+        if (exitCode == -2) {
+            alertResult.setMessage("send script alert msg error, script execution timed out after " + timeout
+                    + " seconds");
+            log.error("send script alert msg error, script execution timed out after {} seconds", timeout);
+            return alertResult;
+        }
         alertResult.setMessage("send script alert msg error,exitCode is " + exitCode);
         log.info("send script alert msg error,exitCode is {}", exitCode);
         return alertResult;
diff --git a/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtilsTest.java b/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtilsTest.java
@@ -17,7 +17,10 @@
 
 package org.apache.dolphinscheduler.plugin.alert.script;
 
+import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.DisabledOnOs;
+import org.junit.jupiter.api.condition.OS;
 
 /**
  * ProcessUtilsTest
@@ -33,7 +36,15 @@ public class ProcessUtilsTest {
 
     @Test
     public void testExecuteScript() {
-        int code = ProcessUtils.executeScript(cmd);
+        int code = ProcessUtils.executeScript(60, cmd);
         assert code != -1;
     }
+
+    @Test
+    @DisabledOnOs(OS.WINDOWS)
+    public void testExecuteScriptTimeout() {
+        String[] sleepCmd = {"/bin/sh", "-c", "sleep 30"};
+        int code = ProcessUtils.executeScript(2, sleepCmd);
+        Assertions.assertEquals(-2, code);
+    }
 }
diff --git a/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptAlertChannelFactoryTest.java b/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptAlertChannelFactoryTest.java
@@ -34,7 +34,7 @@ public class ScriptAlertChannelFactoryTest {
     public void testGetParams() {
         ScriptAlertChannelFactory scriptAlertChannelFactory = new ScriptAlertChannelFactory();
         List<PluginParams> params = scriptAlertChannelFactory.params();
-        Assertions.assertEquals(3, params.size());
+        Assertions.assertEquals(4, params.size());
     }
 
     @Test
diff --git a/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java b/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java
@@ -100,4 +100,19 @@ public void testTypeIsError() {
         assertFalse(alertResult.isSuccess());
     }
 
+    @Test
+    public void testDefaultTimeout() {
+        ScriptSender scriptSender = new ScriptSender(scriptConfig);
+        AlertResult alertResult = scriptSender.sendScriptAlert("test title Kris", "test content");
+        Assertions.assertTrue(alertResult.isSuccess());
+    }
+
+    @Test
+    public void testCustomTimeout() {
+        scriptConfig.put(ScriptParamsConstants.NAME_SCRIPT_TIMEOUT, "30");
+        ScriptSender scriptSender = new ScriptSender(scriptConfig);
+        AlertResult alertResult = scriptSender.sendScriptAlert("test title Kris", "test content");
+        Assertions.assertTrue(alertResult.isSuccess());
+    }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public class ScriptAlertChannelFactoryTest {`
`34`	`34`	`public void testGetParams() {`
`35`	`35`	`ScriptAlertChannelFactory scriptAlertChannelFactory = new ScriptAlertChannelFactory();`
`36`	`36`	`List<PluginParams> params = scriptAlertChannelFactory.params();`
`37`		`- Assertions.assertEquals(3, params.size());`
	`37`	`+ Assertions.assertEquals(4, params.size());`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`@Test`