ELK(elasticsearch+logstash+kibana)實現Java分佈式系統日誌分析架構

ELK(elasticsearch+logstash+kibana)實現Java分佈式系統日誌分析架構

日誌是分析線上問題的重要手段，通常我們會把日誌輸出到控制檯或者本地文件中，排查問題時通過根據關鍵字搜索本地日誌，但越來越多的公司，項目開發中採用分佈式的架構，日誌會記錄到多個服務器或者文件中，分析問題時可能需要查看多個日誌文件才能定位問題，如果相關項目不是一個團隊維護時溝通成本更是直線上升。把各個系統的日誌聚合並通過關鍵字鏈接一個事務處理請求，是分析分佈式系統問題的有效的方式。

ELK(elasticsearch+logstash+kibana)是目前比較常用的日誌分析系統，包括日誌收集(logstash)，日誌存儲搜索(elasticsearch)，展示查詢(kibana)，我們使用ELK作爲日誌的存儲分析系統並通過爲每個請求分配requestId鏈接相關日誌。ELK具體結構如下圖所示:

1、安裝logstash
logstash需要依賴jdk，安裝logstash之前先安裝java環境。
下載JDK:
在oracle的官方網站下載，http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
根據操作系統的版本下載對應的JDK安裝包，本次實驗下載的是jdk-8u101-linux-x64.tar.gz
上傳文件到服務器並執行：
# mkdir /usr/local/java
# tar -zxf jdk-8u45-linux-x64.tar.gz -C /usr/local/java/
配置java環境

export JAVA_HOME=/usr/local/java/jdk1.8.0_45
export PATH=$PATH:$JAVA_HOME/bin
export CLASSPATH=.:$JAVA_HOME/lib/tools.jar:$JAVA_HOME/lib/dt.jar:$CLASSPATH

執行java -version命令，打印出java版本信息表示JDK配置成功。

下載logstash:
wget https://download.elastic.co/logstash/logstash/logstash-2.4.0.tar.gz
tar -xzvf logstash-2.4.0.tar.gz
進入安裝目錄： cd #{dir}/logstash-2.4.0
創建logstash測試配置文件：
vim test.conf
編輯內容如下:

input {
 stdin { }
}
output {
 stdout {
 codec => rubydebug {}
 }
}

運行logstash測試：
bin/logstash -f test.conf
顯示

證明logstash已經啓動了，
輸入hello world

因爲我們配置內容爲，控制檯輸出日誌內容，所以顯示以上格式即爲成功。
2、安裝elasticsearch
下載安裝包：
wget https://download.elastic.co/elasticsearch/release/org/elasticsearch/distribution/tar/elasticsearch/2.4.0/elasticsearch-2.4.0.tar.gz
解壓並配置：
tar -xzvf elasticsearch-2.4.0.tar.gz
cd #{dir}/elasticsearch-2.4.0
vim config/elasticsearch.yml
修改：

path.data: /data/es #數據路徑
path.logs: /data/logs/es #日誌路徑
network.host: 本機地址 #服務器地址
http.port: 9200 #端口

配置執行用戶和目錄：

groupadd elsearch
useradd elsearch -g elsearch -p elasticsearch
chown -R elsearch:elsearch elasticsearch-2.4.0
mkdir /data/es
mkdir /data/logs/es
chown -R elsearch:elsearch /data/es
chown -R elsearch:elsearch /data/logs/es

啓動elasticsearch:
su elsearch
bin/elasticsearch
通過瀏覽器訪問:

安裝成功.
集成logstash和elasticsearch，修改Logstash配置爲：

input {
 stdin { } 
}
output {
 elasticsearch {
 hosts => "elasticsearchIP:9200"
 index => "logstash-test"
 } 
 stdout {
 codec => rubydebug {}
 } 
}

再次啓動logstash，並輸入任意文字：“hello elasticsearch”

通過elasticsearch搜索到了剛纔輸入的文字，集成成功。
但是通過elasticsearch的原生接口查詢和展示都不夠便捷直觀，下面我們配置一下更方便的查詢分析工具kibana。
3、安裝kibana
下載安裝包：
wget https://download.elastic.co/kibana/kibana/kibana-4.6.1-linux-x86_64.tar.gz
解壓kibana，並進入解壓後的目錄
打開config/kibana.yml,修改如下內容
#啓動端口 因爲端口受限 所以變更了默認端口
server.port: 8601
#啓動服務的ip
server.host: “本機ip”
#elasticsearch地址
elasticsearch.url: “http://elasticsearchIP:9200”
啓動程序:
bin/kibana
訪問配置的ip:port，在discover中搜索剛纔輸入的字符，內容非常美觀的展示了出來。

到這裏我們的elk環境已經配置完成了，我們把已java web項目試驗日誌在elk中的使用。
4、創建web工程
一個普通的maven java web工程，爲了測試分佈式系統日誌的連續性，我們讓這個項目自調用n次，並部署2個項目，相互調用，關鍵代碼如下：

@RequestMapping("http_client")
@Controller
public class HttpClientTestController {

    @Autowired
    private HttpClientTestBo httpClientTestBo;

    @RequestMapping(method = RequestMethod.POST)
    @ResponseBody
    public BaseResult doPost(@RequestBody HttpClientTestResult result) {
        HttpClientTestResult testPost = httpClientTestBo.testPost(result);
        return testPost;
    }
}

@Service
public class HttpClientTestBo {

    private static Logger logger = LoggerFactory.getLogger(HttpClientTestBo.class);

    @Value("${test_http_client_url}")
    private String testHttpClientUrl;

    public HttpClientTestResult testPost(HttpClientTestResult result) {
        logger.info(JSONObject.toJSONString(result));
        result.setCount(result.getCount() + 1);
        if (result.getCount() <= 3) {
            Map<String, String> headerMap = new HashMap<String, String>();
            String requestId = RequestIdUtil.requestIdThreadLocal.get();
            headerMap.put(RequestIdUtil.REQUEST_ID_KEY, requestId);
            Map<String, String> paramMap = new HashMap<String, String>();
            paramMap.put("status", result.getStatus() + "");
            paramMap.put("errorCode", result.getErrorCode());
            paramMap.put("message", result.getMessage());
            paramMap.put("count", result.getCount() + "");
            String resultString = JsonHttpClientUtil.post(testHttpClientUrl, headerMap, paramMap, "UTF-8");
            logger.info(resultString);
        }

        logger.info(JSONObject.toJSONString(result));
        return result;
    }
}

爲了表示調用的鏈接性我們在web.xml中配置requestId的filter，用於創建requestId：

<filter>
 <filter-name>requestIdFilter</filter-name>
 <filter-class>com.virxue.baseweb.utils.RequestIdFilter</filter-class>
</filter>
<filter-mapping>
 <filter-name>requestIdFilter</filter-name>
 <url-pattern>/*</url-pattern>
</filter-mapping>

public class RequestIdFilter implements Filter {
    private static final Logger logger = LoggerFactory.getLogger(RequestIdFilter.class);

    /* (non-Javadoc)
     * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
     */
    public void init(FilterConfig filterConfig) throws ServletException {
        logger.info("RequestIdFilter init");
    }

    /* (non-Javadoc)
     * @see javax.servlet.Filter#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)
     */
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException,
        ServletException {
        String requestId = RequestIdUtil.getRequestId((HttpServletRequest) request);
        MDC.put("requestId", requestId);
        chain.doFilter(request, response);
        RequestIdUtil.requestIdThreadLocal.remove();
        MDC.remove("requestId");
    }

    /* (non-Javadoc)
     * @see javax.servlet.Filter#destroy()
     */
    public void destroy() {

    }
}

public class RequestIdUtil {
    public static final String REQUEST_ID_KEY = "requestId";
    public static ThreadLocal<String> requestIdThreadLocal = new ThreadLocal<String>();

    private static final Logger logger = LoggerFactory.getLogger(RequestIdUtil.class);

    /**
     * 獲取requestId
     * @Title getRequestId
     * @Description TODO
     * @return
     *
     * @author sunhaojie [email protected]
     * @date 2016年8月31日 上午7:58:28
     */
    public static String getRequestId(HttpServletRequest request) {
        String requestId = null;
        String parameterRequestId = request.getParameter(REQUEST_ID_KEY);
        String headerRequestId = request.getHeader(REQUEST_ID_KEY);

        if (parameterRequestId == null && headerRequestId == null) {
            logger.info("request parameter 和header 都沒有requestId入參");
            requestId = UUID.randomUUID().toString();
        } else {
            requestId = parameterRequestId != null ? parameterRequestId : headerRequestId;
        }

        requestIdThreadLocal.set(requestId);

        return requestId;
    }
}

我們使使用了Logback作爲日誌輸出的插件，並且使用它的MDC類，可以無侵入的在任何地方輸出requestId，具體的配置如下:

<configuration> 
 <appender name="logfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
 <Encoding>UTF-8</Encoding>
 <File>${log_base}/java-base-web.log</File>
 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 <FileNamePattern>${log_base}/java-base-web-%d{yyyy-MM-dd}-%i.log</FileNamePattern>
 <MaxHistory>10</MaxHistory>
 <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
 <MaxFileSize>200MB</MaxFileSize>
 </TimeBasedFileNamingAndTriggeringPolicy> 
 </rollingPolicy>
 <layout class="ch.qos.logback.classic.PatternLayout">
 <pattern>%d^|^%X{requestId}^|^%-5level^|^%logger{36}%M^|^%msg%n</pattern>
 </layout>
 </appender>
 <root level="info"> 
 <appender-ref ref="logfile" /> 
 </root> 
</configuration>

這裏的日誌格式使用了“^|^”做爲分隔符，方便logstash進行切分。在測試服務器部署2個web項目，並且修改日誌輸出位置，並修改url調用鏈接使項目相互調用。

5、修改logstash讀取項目輸出日誌：
新增stdin.conf，內容如下:

input {
 file {
 path => ["/data/logs/java-base-web1/java-base-web.log", "/data/logs/java-base-web2/java-base-web.log"]
 type => "logs"
 start_position => "beginning"
 codec => multiline {
 pattern => "^\[\d{4}-\d{1,2}-\d{1,2}\s\d{1,2}:\d{1,2}:\d{1,2}"
 negate => true 
 what => "next"
 } 
 } 
}
filter{
 mutate{
 split=>["message","^|^"]
 add_field => {
 "messageJson" => "{datetime:%{[message][0]}, requestId:%{[message][1]},level:%{[message][2]}, class:%{[message][3]}, content:%{[message][4]}}"
 } 
 remove_field => ["message"]
 } 
 
}
output {
 elasticsearch {
 hosts => "10.160.110.48:9200"
 index => "logstash-${type}" 
 } 
 stdout {
 codec => rubydebug {}
 } 
}

其中path爲日誌文件地址；codec => multiline爲處理Exception日誌，使換行的異常內容和異常頭分割在同一個日誌中；filter爲日誌內容切分，把日誌內容做爲json格式，方便查詢分析；

測試一下：

使用POSTMan模擬調用，提示服務器端異常：
通過界面搜索”調用接口異常”，共兩條數據。

使用其中一條數據的requestId搜索，展示出了請求再系統中和系統間的執行過程，方便了我們排查錯誤。

到這裏我們實驗了使用elk配置日誌分析，其中很多細節需要更好的處理，歡迎更多的同學交流學習。

轉載請註明：孫豪傑的博客 » ELK(elasticsearch+logstash+kibana)實現Java分佈式系統日誌分析架構

作者：孫豪傑 http://www.sunhaojie.com