Unverified Commit b9f7da80 authored by BoYiZhang's avatar BoYiZhang Committed by GitHub
Browse files

Merge pull request #8 from apache/dev

update code 
parents b28b4adf de3a81ca
Loading
Loading
Loading
Loading
+53 −0
Original line number Diff line number Diff line
/*
 * 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.alert.manager;

import org.apache.dolphinscheduler.alert.utils.Constants;
import org.apache.dolphinscheduler.alert.utils.DingTalkUtils;
import org.apache.dolphinscheduler.plugin.model.AlertInfo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

/**
 * Ding Talk Manager
 */
public class DingTalkManager {
    private static final Logger logger = LoggerFactory.getLogger(EnterpriseWeChatManager.class);

    public Map<String,Object> send(AlertInfo alert) {
        Map<String,Object> retMap = new HashMap<>();
        retMap.put(Constants.STATUS, false);
        logger.info("send message {}", alert.getAlertData().getTitle());
        try {
            String msg = buildMessage(alert);
            DingTalkUtils.sendDingTalkMsg(msg, Constants.UTF_8);
        } catch (IOException e) {
            logger.error(e.getMessage(),e);
        }
        retMap.put(Constants.STATUS, true);
        return retMap;
    }

    private String buildMessage(AlertInfo alert) {
        String msg = alert.getAlertData().getContent();
        return msg;
    }
}
+8 −0
Original line number Diff line number Diff line
@@ -16,9 +16,11 @@
 */
package org.apache.dolphinscheduler.alert.plugin;

import org.apache.dolphinscheduler.alert.manager.DingTalkManager;
import org.apache.dolphinscheduler.alert.manager.EmailManager;
import org.apache.dolphinscheduler.alert.manager.EnterpriseWeChatManager;
import org.apache.dolphinscheduler.alert.utils.Constants;
import org.apache.dolphinscheduler.alert.utils.DingTalkUtils;
import org.apache.dolphinscheduler.alert.utils.EnterpriseWeChatUtils;
import org.apache.dolphinscheduler.common.utils.CollectionUtils;
import org.apache.dolphinscheduler.common.utils.StringUtils;
@@ -44,6 +46,7 @@ public class EmailAlertPlugin implements AlertPlugin {

    private static final EmailManager emailManager = new EmailManager();
    private static final EnterpriseWeChatManager weChatManager = new EnterpriseWeChatManager();
    private static final DingTalkManager dingTalkManager = new DingTalkManager();

    public EmailAlertPlugin() {
        this.pluginName = new PluginName();
@@ -122,6 +125,11 @@ public class EmailAlertPlugin implements AlertPlugin {
                }
            }
            
           if (DingTalkUtils.isEnableDingTalk) {
                logger.info("Ding Talk is enable.");
                 dingTalkManager.send(info);
              }

        } else {
            retMaps.put(Constants.MESSAGE, "alert send error.");
            logger.info("alert send error : {}", retMaps.get(Constants.MESSAGE));
+18 −0
Original line number Diff line number Diff line
@@ -157,6 +157,23 @@ public class Constants {

    public static final String ENTERPRISE_WECHAT_USERS = "enterprise.wechat.users";
    

    public static final String DINGTALK_WEBHOOK = "dingtalk.webhook";

    public static final String DINGTALK_KEYWORD = "dingtalk.keyword";

    public static final String DINGTALK_PROXY_ENABLE = "dingtalk.isEnableProxy";

    public static final String DINGTALK_PROXY = "dingtalk.proxy";

    public static final String DINGTALK_PORT = "dingtalk.port";

    public static final String DINGTALK_USER = "dingtalk.user";

    public static final String DINGTALK_PASSWORD = "dingtalk.password";

    public static final String DINGTALK_ENABLE = "dingtalk.isEnable";

    /**
     * plugin config
     */
@@ -173,4 +190,5 @@ public class Constants {
    public static final String PLUGIN_DEFAULT_EMAIL_RECEIVERCCS = "receiverCcs";

    public static final String RETMAP_MSG = "msg";

}
+136 −0
Original line number Diff line number Diff line
/*
 * 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.alert.utils;


import com.alibaba.fastjson.JSON;
import org.apache.commons.codec.binary.StringUtils;
import org.apache.http.HttpEntity;
import org.apache.http.HttpHost;
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.CredentialsProvider;
import org.apache.http.client.config.RequestConfig;
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.BasicCredentialsProvider;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

/**
 * DingTalkUtils utils
 * support send msg to ding talk by robot message push function.
 * support proxy setting
 */
public class DingTalkUtils {
    public static final Logger logger = LoggerFactory.getLogger(DingTalkUtils.class);

    public static final boolean isEnableDingTalk = PropertyUtils.getBoolean(Constants.DINGTALK_ENABLE);
    private static final String dingTaskUrl = PropertyUtils.getString(Constants.DINGTALK_WEBHOOK);
    private static final String keyword = PropertyUtils.getString(Constants.DINGTALK_KEYWORD);
    private static final Boolean isEnableProxy = PropertyUtils.getBoolean(Constants.DINGTALK_PROXY_ENABLE);
    private static final String proxy = PropertyUtils.getString(Constants.DINGTALK_PROXY);
    private static final String user = PropertyUtils.getString(Constants.DINGTALK_USER);
    private static final String passwd = PropertyUtils.getString(Constants.DINGTALK_PASSWORD);
    private static final Integer port = PropertyUtils.getInt(Constants.DINGTALK_PORT);

    /**
     * send message interface
     * only support text message format now.
     * @param msg message context to send
     * @param charset charset type
     * @return  result of sending msg
     * @throws IOException the IOException
     */
    public static String sendDingTalkMsg(String msg, String charset) throws IOException {
        String msgToJson = textToJsonString(msg + "#" + keyword);
        HttpPost httpPost = constructHttpPost(msgToJson, charset);

        CloseableHttpClient httpClient;
        if (isEnableProxy) {
            httpClient = getProxyClient();
            RequestConfig rcf = getProxyConfig();
            httpPost.setConfig(rcf);
        } else {
            httpClient = getDefaultClient();
        }

        try {
            CloseableHttpResponse response = httpClient.execute(httpPost);
            String resp;
            try {
                HttpEntity entity = response.getEntity();
                resp = EntityUtils.toString(entity, charset);
                EntityUtils.consume(entity);
            } finally {
                response.close();
            }
            logger.info("Ding Talk send [{}], resp:{%s}", msg, resp);
            return resp;
        }  finally {
            httpClient.close();
        }
    }

    public static HttpPost constructHttpPost(String msg, String charset) {
        HttpPost post =  new HttpPost(dingTaskUrl);
        StringEntity entity = new StringEntity(msg, charset);
        post.setEntity(entity);
        post.addHeader("Content-Type", "application/json; charset=utf-8");
        return post;
    }


    public static CloseableHttpClient getProxyClient() {
        HttpHost httpProxy = new HttpHost(proxy, port);
        CredentialsProvider provider = new BasicCredentialsProvider();
        provider.setCredentials(new AuthScope(httpProxy), new UsernamePasswordCredentials(user, passwd));
        CloseableHttpClient httpClient = HttpClients.custom().setDefaultCredentialsProvider(provider).build();
        return httpClient;
    }

    public static CloseableHttpClient getDefaultClient() {
        return HttpClients.createDefault();
    }

    public static RequestConfig getProxyConfig() {
        HttpHost httpProxy = new HttpHost(proxy, port);
        return RequestConfig.custom().setProxy(httpProxy).build();
    }

    public static String textToJsonString(String text) {
        Map<String, Object> items = new HashMap<String, Object>();
        items.put("msgtype", "text");
        Map<String, String> textContent = new HashMap<String, String>();
        byte[] byt = StringUtils.getBytesUtf8(text);
        String txt = StringUtils.newStringUtf8(byt);
        textContent.put("content", txt);
        items.put("text", textContent);

        return JSON.toJSONString(items);

    }

}
+11 −0
Original line number Diff line number Diff line
@@ -36,6 +36,7 @@ mail.smtp.ssl.trust=xxx.xxx.com

# Enterprise WeChat configuration
enterprise.wechat.enable=false

#enterprise.wechat.corp.id=xxxxxxx
#enterprise.wechat.secret=xxxxxxx
#enterprise.wechat.agent.id=xxxxxxx
@@ -47,3 +48,13 @@ enterprise.wechat.enable=false

plugin.dir=/Users/xx/your/path/to/plugin/dir

#ding talk configuration
dingtalk.isEnable=flase
dingtalk.webhook=https://oapi.dingtalk.com/robot/send?access_token=xxxxx
dingtalk.keyword=
dingtalk.proxy=
dingtalk.port=80
dingtalk.user=
dingtalk.password=
dingtalk.isEnableProxy=false
Loading