top.gotoeasy.framework.glc.logback.appender.GlcHttpJsonAppender Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of glc-logback-appender Show documentation
logback appender for glogcenter
There is a newer version: 0.17.1
package top.gotoeasy.framework.glc.logback.appender;

import java.io.DataOutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.AppenderBase;
import ch.qos.logback.core.Layout;

/**
 * GLC是glogcenter缩写，一个golang实现的日志中心

 * GlcHttpJsonAppender提供一种http提交Json数据的方式发送日志到GLC，适用于使用logback做日志管理的java项目

 * 仅简易实现为主，若是性能要求高日志量大的场景，应选用其他比如消息队列之类的Appender
 */
public class GlcHttpJsonAppender extends AppenderBase {

    // 自定义配置，需Getter和Setter方法
    private String glcApiUrl;
    private String glcApiKey;
    private String system = "default";
    private Layout layout;

    private String headerKey;
    private String headerVal;

    private int cnt = 0;
    private boolean enableGlc = true;

    private ExecutorService executor = Executors.newSingleThreadExecutor();

    @Override
    protected void append(ILoggingEvent event) {
        if (!enableGlc) {
            return; // 未启用时跳过
        }

        if (event == null || !isStarted()) {
            if (cnt++ < 10) {
                System.err.println("日志事件为空或该Appender未被初始化");
            }
            return;
        }

        // 异步发送日志到GLC
        executor.execute(() -> {
            submitToGlogCenter(layout.doLayout(event), event);
        });
    }

    /**
     * 发送日志到GLC

     * 为不依赖第三方包，仅作java原生包简单实现，性能较差

     * 实际使用时若有性能问题可继承重写实现
     * 
     * @param text  日志
     * @param event ILoggingEvent
     */
    protected void submitToGlogCenter(String text, ILoggingEvent event) {
        if (text == null) {
            return; // ignore
        }

        DataOutputStream dos = null;
        String body = null;
        try {
            String traceid = event.getMDCPropertyMap().get(MdcUtil.TRACE_ID);
            String clientip = event.getMDCPropertyMap().get(MdcUtil.CLIENT_IP);
            String user = event.getMDCPropertyMap().get(MdcUtil.USER);

            body = "{\"text\":" + Util.encodeStr(text.trim());
            body += ",\"date\":\"" + Util.getDateString() + "\"";
            body += ",\"system\":" + Util.encodeStr(getSystem());
            body += ",\"servername\":" + Util.encodeStr(Util.getServerName());
            body += ",\"serverip\":" + Util.encodeStr(Util.getServerIp());
            body += ",\"loglevel\":\"" + event.getLevel().toString() + "\"";
            if (traceid != null && !"".equals(traceid)) {
                body += ",\"traceid\":" + Util.encodeStr(traceid);
            }
            if (clientip != null && !"".equals(clientip)) {
                body += ",\"clientip\":" + Util.encodeStr(clientip);
            }
            if (user != null && !"".equals(user)) {
                body += ",\"user\":" + Util.encodeStr(user);
            }
            body += "}";

            URL url = new URL(glcApiUrl);
            HttpURLConnection connection = (HttpURLConnection)url.openConnection();
            // 设置header
            if (headerKey != null && !"".equals(headerVal)) {
                connection.setRequestProperty(headerKey, headerVal);
            }
            connection.setConnectTimeout(5000);
            connection.setReadTimeout(5000);
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.setUseCaches(false);
            connection.setRequestMethod("POST");
            connection.setRequestProperty("Content-Type", "application/json");
            // 发送日志数据
            connection.connect();
            dos = new DataOutputStream(connection.getOutputStream());
            dos.write(body.getBytes("utf-8"));
            dos.flush();
            // 接收响应内筒
            connection.getContent();
            connection.disconnect();
        } catch (Exception e) {
            if (cnt++ < 10) {
                System.err.println("[GLC日志发送异常][地址：" + glcApiUrl + "][异常信息：" + e.getMessage() + "]");
            }
        } finally {
            try {
                if (dos != null) {
                    dos.close();
                }
            } catch (Exception e) {
                // ignore
            }
        }
    }

    @Override
    public void start() {
        if (this.layout == null) {
            System.err.println("Layout未被初始化");
        }
        super.start();

        // 优先使用环境变量设定
        String enable = System.getenv("GLC_ENABLE");
        if ("false".equalsIgnoreCase(enable) || "0".equals(enable)) {
            enableGlc = false;
        }
        String apiUrl = System.getenv("GLC_API_URL");
        if (apiUrl != null) {
            apiUrl = apiUrl.trim();
            if (!"".equals(apiUrl)) {
                setGlcApiUrl(apiUrl);
            }
        }

        String apiKey = System.getenv("GLC_API_KEY");
        if (apiKey != null) {
            apiKey = apiKey.trim();
            if (!"".equals(apiKey)) {
                setGlcApiKey(apiKey);
            }
        }

        String system = System.getenv("GLC_SYSTEM");
        if (system != null) {
            system = system.trim();
            if (!"".equals(system)) {
                setSystem(system);
            }
        }
    }

    @Override
    public void stop() {
        if (!isStarted()) {
            return;
        }
        super.stop();
    }

    public Layout getLayout() {
        return layout;
    }

    public void setLayout(Layout layout) {
        this.layout = layout;
    }

    public String GetGlcApiUrl() {
        return glcApiUrl;
    }

    public void setGlcApiUrl(String glcApiUrl) {
        this.glcApiUrl = glcApiUrl;
    }

    public String GetGlcApiKey() {
        return glcApiKey;
    }

    public void setSystem(String system) {
        this.system = system;
    }

    public String getSystem() {
        return system == null ? "" : system;
    }

    public void setGlcApiKey(String glcApiKey) {
        this.glcApiKey = glcApiKey;

        String key = glcApiKey.split(":")[0];
        String value = glcApiKey.substring(key.length() + 1).trim();
        key = key.trim();
        if (!"".equals(key)) {
            headerKey = key;
            headerVal = value;
        }
    }

}