[Feature-7992][Alert] Support PagerDuty Plugin (#8120)

Co-authored-by: qingwli <qingwli@cisco.com>

dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-pagerduty/pom.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one or more
+  ~ contributor license agreements.  See the NOTICE file distributed with
+  ~ this work for additional information regarding copyright ownership.
+  ~ The ASF licenses this file to You under the Apache License, Version 2.0
+  ~ (the "License"); you may not use this file except in compliance with
+  ~ the License.  You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>dolphinscheduler-alert-plugins</artifactId>
+        <groupId>org.apache.dolphinscheduler</groupId>
+        <version>2.0.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>dolphinscheduler-alert-pagerduty</artifactId>
+    <packaging>jar</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+        </dependency>
+    </dependencies>
+</project>

dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-pagerduty/src/main/java/org/apache/dolphinscheduler/plugin/alert/pagerduty/PagerDutyAlertChannel.java

@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.dolphinscheduler.plugin.alert.pagerduty;
+
+import org.apache.dolphinscheduler.alert.api.AlertChannel;
+import org.apache.dolphinscheduler.alert.api.AlertData;
+import org.apache.dolphinscheduler.alert.api.AlertInfo;
+import org.apache.dolphinscheduler.alert.api.AlertResult;
+
+import java.util.Map;
+
+public final class PagerDutyAlertChannel implements AlertChannel {
+    @Override
+    public AlertResult process(AlertInfo alertInfo) {
+        AlertData alertData = alertInfo.getAlertData();
+        Map<String, String> alertParams = alertInfo.getAlertParams();
+        if (alertParams == null || alertParams.size() == 0) {
+            return new AlertResult("false", "PagerDuty alert params is empty");
+        }
+
+        return new PagerDutySender(alertParams).sendPagerDutyAlter(alertData.getTitle(), alertData.getContent());
+    }
+}

dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-pagerduty/src/main/java/org/apache/dolphinscheduler/plugin/alert/pagerduty/PagerDutyAlertChannelFactory.java

@@ -0,0 +1,51 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.dolphinscheduler.plugin.alert.pagerduty;
+
+import com.google.auto.service.AutoService;
+import org.apache.dolphinscheduler.alert.api.AlertChannel;
+import org.apache.dolphinscheduler.alert.api.AlertChannelFactory;
+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 java.util.Collections;
+import java.util.List;
+
+@AutoService(AlertChannelFactory.class)
+public final class PagerDutyAlertChannelFactory implements AlertChannelFactory {
+    @Override
+    public String name() {
+        return "PagerDuty";
+    }
+
+    @Override
+    public List<PluginParams> params() {
+        InputParam integrationKey = InputParam.newBuilder(PagerDutyParamsConstants.NAME_PAGER_DUTY_INTEGRATION_KEY_NAME, PagerDutyParamsConstants.PAGER_DUTY_INTEGRATION_KEY)
+                .addValidate(Validate.newBuilder()
+                        .setRequired(true)
+                        .build())
+                .build();
+
+        return Collections.singletonList(integrationKey);
+    }
+
+    @Override
+    public AlertChannel create() {
+        return new PagerDutyAlertChannel();
+    }
+}

dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-pagerduty/src/main/java/org/apache/dolphinscheduler/plugin/alert/pagerduty/PagerDutyParamsConstants.java

@@ -0,0 +1,30 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.dolphinscheduler.plugin.alert.pagerduty;
+
+public final class PagerDutyParamsConstants {
+    public static final String NAME_PAGER_DUTY_INTEGRATION_KEY_NAME = "IntegrationKey";
+    public static final String PAGER_DUTY_INTEGRATION_KEY = "integrationKey";
+    public static final String PAGER_DUTY_EVENT_ACTION_TRIGGER = "trigger";
+    public static final String PAGER_DUTY_EVENT_API = "https://events.pagerduty.com/v2/enqueue";
+    public static final String PAGER_DUTY_EVENT_SOURCE = "DolphinScheduler";
+
+    private PagerDutyParamsConstants() {
+        throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
+    }
+}

dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-pagerduty/src/main/java/org/apache/dolphinscheduler/plugin/alert/pagerduty/PagerDutySender.java

@@ -0,0 +1,129 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.dolphinscheduler.plugin.alert.pagerduty;
+
+import com.google.common.base.Preconditions;
+import org.apache.dolphinscheduler.alert.api.AlertResult;
+import org.apache.dolphinscheduler.spi.utils.JSONUtils;
+import org.apache.http.HttpStatus;
+import org.apache.http.client.methods.CloseableHttpResponse;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.entity.StringEntity;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.HttpClients;
+import org.slf4j.Logger;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.util.*;
+
+public final class PagerDutySender {
+    private static final Logger log = org.slf4j.LoggerFactory.getLogger(PagerDutySender.class);
+
+    private final String integrationKey;
+
+    public PagerDutySender(Map<String, String> config) {
+        integrationKey = config.get(PagerDutyParamsConstants.NAME_PAGER_DUTY_INTEGRATION_KEY_NAME);
+        Preconditions.checkArgument(!Objects.isNull(integrationKey), "PagerDuty integration key can not be null");
+    }
+
+    public AlertResult sendPagerDutyAlter(String title, String content){
+        AlertResult alertResult = new AlertResult();
+        alertResult.setStatus("false");
+        alertResult.setMessage("send pager duty alert fail.");
+
+        try {
+            sendPagerDutyAlterV2(alertResult, title, content);
+        } catch (Exception e) {
+            log.info("send pager duty alert exception : {}", e.getMessage());
+        }
+
+        return alertResult;
+    }
+
+    private AlertResult sendPagerDutyAlterV2(AlertResult alertResult, String title, String content) throws IOException {
+        String requestBody = textToJsonStringV2(title, content);
+        return send(alertResult, PagerDutyParamsConstants.PAGER_DUTY_EVENT_API, requestBody);
+    }
+
+    private AlertResult send(AlertResult alertResult, String url, String requestBody) throws IOException {
+        HttpPost httpPost = constructHttpPost(url, requestBody);
+        CloseableHttpClient httpClient = HttpClients.createDefault();
+
+        try {
+            CloseableHttpResponse response = httpClient.execute(httpPost);
+
+            int statusCode = response.getStatusLine().getStatusCode();
+            try {
+                if (statusCode == HttpStatus.SC_OK || statusCode == HttpStatus.SC_ACCEPTED) {
+                    alertResult.setStatus("true");
+                    alertResult.setMessage("send pager duty alert success");
+                }else {
+                    log.info("send pager duty alert fail, statusCode : {}", statusCode);
+                }
+            }finally {
+                response.close();
+            }
+        } catch (IOException e) {
+            log.info("send pager duty alert exception : {}", e.getMessage());
+        } finally {
+            httpClient.close();
+        }
+
+        return alertResult;
+    }
+
+    private String textToJsonStringV2(String title, String content) {
+        Map<String, Object> items = new HashMap<>();
+        items.put("routing_key", integrationKey);
+        items.put("event_action", PagerDutyParamsConstants.PAGER_DUTY_EVENT_ACTION_TRIGGER);
+        Map<String, Object> payload = new HashMap<>();
+        payload.put("summary", title);
+        payload.put("source", PagerDutyParamsConstants.PAGER_DUTY_EVENT_SOURCE);
+        payload.put("severity", "critical");
+        payload.put("custom_details", formatContent(content));
+        items.put("payload", payload);
+        return JSONUtils.toJsonString(items);
+    }
+
+    private static HttpPost constructHttpPost(String url, String requestBody) {
+        HttpPost post = new HttpPost(url);
+        StringEntity entity = new StringEntity(requestBody, StandardCharsets.UTF_8);
+        post.setEntity(entity);
+        post.addHeader("Content-Type", "application/json; charset=utf-8");
+        return post;
+    }
+
+    public static String formatContent(String content) {
+        List<Map> list = JSONUtils.toList(content, Map.class);
+        if (list.isEmpty()) {
+            return content;
+        }
+
+        StringBuilder contents = new StringBuilder(100);
+        for (Map map : list) {
+            for (Map.Entry<String, Object> entry : (Iterable<Map.Entry<String, Object>>) map.entrySet()) {
+                String key = entry.getKey();
+                String value = entry.getValue().toString();
+                contents.append(key + ":" + value);
+                contents.append("\n");
+            }
+        }
+
+        return contents.toString();
+    }
+}

dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-pagerduty/src/test/java/org/apache/dolphinscheduler/plugin/alert/pagerduty/PagerDutyAlertChannelFactoryTest.java

@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.dolphinscheduler.plugin.alert.pagerduty;
+
+import org.apache.dolphinscheduler.alert.api.AlertChannel;
+import org.apache.dolphinscheduler.spi.params.base.PluginParams;
+import org.apache.dolphinscheduler.spi.utils.JSONUtils;
+import java.util.List;
+import org.junit.Assert;
+import org.junit.Test;
+
+public class PagerDutyAlertChannelFactoryTest {
+
+    @Test
+    public void testGetParams() {
+        PagerDutyAlertChannelFactory pagerDutyAlertChannelFactory = new PagerDutyAlertChannelFactory();
+        List<PluginParams> params = pagerDutyAlertChannelFactory.params();
+        JSONUtils.toJsonString(params);
+        Assert.assertEquals(1, params.size());
+    }
+
+    @Test
+    public void testCreate() {
+        PagerDutyAlertChannelFactory pagerDutyAlertChannelFactory = new PagerDutyAlertChannelFactory();
+        AlertChannel alertChannel = pagerDutyAlertChannelFactory.create();
+        Assert.assertNotNull(alertChannel);
+    }
+}

dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-pagerduty/src/test/java/org/apache/dolphinscheduler/plugin/alert/pagerduty/PagerDutySenderTest.java

@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.dolphinscheduler.plugin.alert.pagerduty;
+
+import org.apache.dolphinscheduler.alert.api.AlertResult;
+import java.util.HashMap;
+import java.util.Map;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+public class PagerDutySenderTest {
+    private static final Map<String, String> pagerDutyConfig = new HashMap<>();
+
+    @Before
+    public void initDingTalkConfig() {
+        pagerDutyConfig.put(PagerDutyParamsConstants.NAME_PAGER_DUTY_INTEGRATION_KEY_NAME, "test");
+    }
+
+    @Test
+    public void testSend() {
+        PagerDutySender pagerDutySender = new PagerDutySender(pagerDutyConfig);
+        AlertResult alertResult = pagerDutySender.sendPagerDutyAlter("pagerduty test title", "pagerduty test content");
+        Assert.assertEquals("false", alertResult.getStatus());
+    }
+}

dolphinscheduler-alert/dolphinscheduler-alert-plugins/pom.xml

@@ -35,6 +35,7 @@
         <module>dolphinscheduler-alert-http</module>
         <module>dolphinscheduler-alert-feishu</module>
         <module>dolphinscheduler-alert-slack</module>
+        <module>dolphinscheduler-alert-pagerduty</module>
     </modules>
 
     <dependencies>

dolphinscheduler-alert/dolphinscheduler-alert-server/pom.xml

@@ -66,6 +66,10 @@
             <groupId>org.apache.dolphinscheduler</groupId>
             <artifactId>dolphinscheduler-alert-wechat</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.apache.dolphinscheduler</groupId>
+            <artifactId>dolphinscheduler-alert-pagerduty</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>org.apache.dolphinscheduler</groupId>

pom.xml

@@ -345,6 +345,11 @@
                 <artifactId>dolphinscheduler-alert-wechat</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>org.apache.dolphinscheduler</groupId>
+                <artifactId>dolphinscheduler-alert-pagerduty</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>org.apache.dolphinscheduler</groupId>
                 <artifactId>dolphinscheduler-registry-api</artifactId>