摘要

ELK日誌收集系統進階使用，本文主要講解如何打造一個線上環境真實可用的日誌收集系統。有了它，你就可以和去伺服器上撈日誌說再見了！

ELK環境安裝

ELK是指Elasticsearch、Kibana、Logstash這三種服務搭建的日誌收集系統，具體搭建方式可以參考《SpringBoot應用整合ELK實現日誌收集》。這裡僅提供最新版本的docker-compose指令碼和一些安裝要點。

docker-compose指令碼

1. version: '3'

2. services:

3. elasticsearch:

4. image: elasticsearch:6.4.0

5. container_name: elasticsearch

6. environment:

7. - "cluster.name=elasticsearch" #設定叢集名稱為elasticsearch

8. - "discovery.type=single-node" #以單一節點模式啟動

9. - "ES_JAVA_OPTS=-Xms512m -Xmx512m" #設定使用jvm記憶體大小

10. - TZ=Asia/Shanghai

11. volumes:

12. - /mydata/elasticsearch/plugins:/usr/share/elasticsearch/plugins #外掛檔案掛載

13. - /mydata/elasticsearch/data:/usr/share/elasticsearch/data #資料檔案掛載

14. ports:

15. - 9200:9200

16. - 9300:9300

17. kibana:

18. image: kibana:6.4.0

19. container_name: kibana

20. links:

21. - elasticsearch:es #可以用es這個域名訪問elasticsearch服務

22. depends_on:

23. - elasticsearch #kibana在elasticsearch啟動之後再啟動

24. environment:

25. - "elasticsearch.hosts=http://es:9200" #設定訪問elasticsearch的地址

26. - TZ=Asia/Shanghai

27. ports:

28. - 5601:5601

29. logstash:

30. image: logstash:6.4.0

31. container_name: logstash

32. environment:

33. - TZ=Asia/Shanghai

34. volumes:

35. - /mydata/logstash/logstash.conf:/usr/share/logstash/pipeline/logstash.conf #掛載logstash的配置檔案

36. depends_on:

37. - elasticsearch #kibana在elasticsearch啟動之後再啟動

38. links:

39. - elasticsearch:es #可以用es這個域名訪問elasticsearch服務

40. ports:

41. - 4560:4560

42. - 4561:4561

43. - 4562:4562

44. - 4563:4563

安裝要點

• 使用docker-compose命令執行所有服務：

docker-compose up -d

• 第一次啟動可能會發現Elasticsearch無法啟動，那是因為/usr/share/elasticsearch/data目錄沒有訪問許可權，只需要修改/mydata/elasticsearch/data目錄的許可權，再重新啟動；

chmod 777 /mydata/elasticsearch/data/

• Logstash需要安裝json_lines外掛。

1. logstash-plugin install logstash-codec-json_lines

2. 複製程式碼

分場景收集日誌

這裡為了方便我們檢視日誌，提出一個分場景收集日誌的概念，把日誌分為以下四種。

• 除錯日誌：最全日誌，包含了應用中所有DEBUG級別以上的日誌，僅在開發、測試環境中開啟收集；
• 錯誤日誌：只包含應用中所有ERROR級別的日誌，所有環境只都開啟收集；
• 業務日誌：在我們應用對應包下列印的日誌，可用於檢視我們自己在應用中列印的業務日誌；
• 記錄日誌：每個介面的訪問記錄，可以用來檢視介面執行效率，獲取介面訪問引數。

Logback配置詳解

要實現上面的分場景收集日誌，主要通過Logback的配置來實現，我們先來了解下Logback的配置吧！

完全配置

在SpringBoot中，如果我們想要自定義Logback的配置，需要自行編寫logback-spring.xml檔案，下面是我們這次要使用的完全配置。

1. <?xml version="1.0" encoding="UTF-8"?>

2. <!DOCTYPE configuration>

3. <configuration>

4. <!--引用預設日誌配置-->

5. <include resource="org/springframework/boot/logging/logback/defaults.xml"/>

6. <!--使用預設的控制檯日誌輸出實現-->

7. <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>

8. <!--應用名稱-->

9. <springProperty scope="context" name="APP_NAME" source="spring.application.name" defaultValue="springBoot"/>

10. <!--日誌檔案儲存路徑-->

11. <property name="LOG_FILE_PATH" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/logs}"/>

12. <!--LogStash訪問host-->

13. <springProperty name="LOG_STASH_HOST" scope="context" source="logstash.host" defaultValue="localhost"/>

15. <!--DEBUG日誌輸出到檔案-->

16. <appender name="FILE_DEBUG"

17. class="ch.qos.logback.core.rolling.RollingFileAppender">

18. <!--輸出DEBUG以上級別日誌-->

19. <filter class="ch.qos.logback.classic.filter.ThresholdFilter">

20. <level>DEBUG</level>

21. </filter>

22. <encoder>

23. <!--設定為預設的檔案日誌格式-->

24. <pattern>${FILE_LOG_PATTERN}</pattern>

25. <charset>UTF-8</charset>

26. </encoder>

27. <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">

28. <!--設定檔案命名格式-->

29. <fileNamePattern>${LOG_FILE_PATH}/debug/${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>

30. <!--設定日誌檔案大小，超過就重新生成檔案，預設10M-->

31. <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>

32. <!--日誌檔案保留天數，預設30天-->

33. <maxHistory>${LOG_FILE_MAX_HISTORY:-30}</maxHistory>

34. </rollingPolicy>

35. </appender>

37. <!--ERROR日誌輸出到檔案-->

38. <appender name="FILE_ERROR"

39. class="ch.qos.logback.core.rolling.RollingFileAppender">

40. <!--只輸出ERROR級別的日誌-->

41. <filter class="ch.qos.logback.classic.filter.LevelFilter">

42. <level>ERROR</level>

43. <onMatch>ACCEPT</onMatch>

44. <onMismatch>DENY</onMismatch>

45. </filter>

46. <encoder>

47. <!--設定為預設的檔案日誌格式-->

48. <pattern>${FILE_LOG_PATTERN}</pattern>

49. <charset>UTF-8</charset>

50. </encoder>

51. <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">

52. <!--設定檔案命名格式-->

53. <fileNamePattern>${LOG_FILE_PATH}/error/${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>

54. <!--設定日誌檔案大小，超過就重新生成檔案，預設10M-->

55. <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>

56. <!--日誌檔案保留天數，預設30天-->

57. <maxHistory>${LOG_FILE_MAX_HISTORY:-30}</maxHistory>

58. </rollingPolicy>

59. </appender>

61. <!--DEBUG日誌輸出到LogStash-->

62. <appender name="LOG_STASH_DEBUG" class="net.logstash.logback.appender.LogstashTcpSocketAppender">

63. <filter class="ch.qos.logback.classic.filter.ThresholdFilter">

64. <level>DEBUG</level>

65. </filter>

66. <destination>${LOG_STASH_HOST}:4560</destination>

67. <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">

68. <providers>

69. <timestamp>

70. <timeZone>Asia/Shanghai</timeZone>

71. </timestamp>

72. <!--自定義日誌輸出格式-->

73. <pattern>

74. <pattern>

75. {

76. "project": "mall-tiny",

77. "level": "%level",

78. "service": "${APP_NAME:-}",

79. "pid": "${PID:-}",

80. "thread": "%thread",

81. "class": "%logger",

82. "message": "%message",

83. "stack_trace": "%exception{20}"

84. }

85. </pattern>

86. </pattern>

87. </providers>

88. </encoder>

89. <!--當有多個LogStash服務時，設定訪問策略為輪詢-->

90. <connectionStrategy>

91. <roundRobin>

92. <connectionTTL>5 minutes</connectionTTL>

93. </roundRobin>

94. </connectionStrategy>

95. </appender>

97. <!--ERROR日誌輸出到LogStash-->

98. <appender name="LOG_STASH_ERROR" class="net.logstash.logback.appender.LogstashTcpSocketAppender">

99. <filter class="ch.qos.logback.classic.filter.LevelFilter">

100. <level>ERROR</level>

101. <onMatch>ACCEPT</onMatch>

102. <onMismatch>DENY</onMismatch>

103. </filter>

104. <destination>${LOG_STASH_HOST}:4561</destination>

105. <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">

106. <providers>

107. <timestamp>

108. <timeZone>Asia/Shanghai</timeZone>

109. </timestamp>

110. <!--自定義日誌輸出格式-->

111. <pattern>

112. <pattern>

113. {

114. "project": "mall-tiny",

115. "level": "%level",

116. "service": "${APP_NAME:-}",

117. "pid": "${PID:-}",

118. "thread": "%thread",

119. "class": "%logger",

120. "message": "%message",

121. "stack_trace": "%exception{20}"

122. }

123. </pattern>

124. </pattern>

125. </providers>

126. </encoder>

127. <!--當有多個LogStash服務時，設定訪問策略為輪詢-->

128. <connectionStrategy>

129. <roundRobin>

130. <connectionTTL>5 minutes</connectionTTL>

131. </roundRobin>

132. </connectionStrategy>

133. </appender>

135. <!--業務日誌輸出到LogStash-->

136. <appender name="LOG_STASH_BUSINESS" class="net.logstash.logback.appender.LogstashTcpSocketAppender">

137. <destination>${LOG_STASH_HOST}:4562</destination>

138. <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">

139. <providers>

140. <timestamp>

141. <timeZone>Asia/Shanghai</timeZone>

142. </timestamp>

143. <!--自定義日誌輸出格式-->

144. <pattern>

145. <pattern>

146. {

147. "project": "mall-tiny",

148. "level": "%level",

149. "service": "${APP_NAME:-}",

150. "pid": "${PID:-}",

151. "thread": "%thread",

152. "class": "%logger",

153. "message": "%message",

154. "stack_trace": "%exception{20}"

155. }

156. </pattern>

157. </pattern>

158. </providers>

159. </encoder>

160. <!--當有多個LogStash服務時，設定訪問策略為輪詢-->

161. <connectionStrategy>

162. <roundRobin>

163. <connectionTTL>5 minutes</connectionTTL>

164. </roundRobin>

165. </connectionStrategy>

166. </appender>

168. <!--介面訪問記錄日誌輸出到LogStash-->

169. <appender name="LOG_STASH_RECORD" class="net.logstash.logback.appender.LogstashTcpSocketAppender">

170. <destination>${LOG_STASH_HOST}:4563</destination>

171. <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">

172. <providers>

173. <timestamp>

174. <timeZone>Asia/Shanghai</timeZone>

175. </timestamp>

176. <!--自定義日誌輸出格式-->

177. <pattern>

178. <pattern>

179. {

180. "project": "mall-tiny",

181. "level": "%level",

182. "service": "${APP_NAME:-}",

183. "class": "%logger",

184. "message": "%message"

185. }

186. </pattern>

187. </pattern>

188. </providers>

189. </encoder>

190. <!--當有多個LogStash服務時，設定訪問策略為輪詢-->

191. <connectionStrategy>

192. <roundRobin>

193. <connectionTTL>5 minutes</connectionTTL>

194. </roundRobin>

195. </connectionStrategy>

196. </appender>

198. <!--控制框架輸出日誌-->

199. <logger name="org.slf4j" level="INFO"/>

200. <logger name="springfox" level="INFO"/>

201. <logger name="io.swagger" level="INFO"/>

202. <logger name="org.springframework" level="INFO"/>

203. <logger name="org.hibernate.validator" level="INFO"/>

205. <root level="DEBUG">

206. <appender-ref ref="CONSOLE"/>

207. <!--<appender-ref ref="FILE_DEBUG"/>-->

208. <!--<appender-ref ref="FILE_ERROR"/>-->

209. <appender-ref ref="LOG_STASH_DEBUG"/>

210. <appender-ref ref="LOG_STASH_ERROR"/>

211. </root>

213. <logger name="com.macro.mall.tiny.component" level="DEBUG">

214. <appender-ref ref="LOG_STASH_RECORD"/>

215. </logger>

217. <logger name="com.macro.mall" level="DEBUG">

218. <appender-ref ref="LOG_STASH_BUSINESS"/>

219. </logger>

220. </configuration>

配置要點解析

使用預設的日誌配置

一般我們不需要自定義控制檯輸出，可以採用預設配置，具體配置參考console-appender.xml，該檔案在spring-boot-${version}.jar下面。

1. <!--引用預設日誌配置-->

2. <include resource="org/springframework/boot/logging/logback/defaults.xml"/>

3. <!--使用預設的控制檯日誌輸出實現-->

4. <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>

springProperty

該標籤可以從SpringBoot的配置檔案中獲取配置屬性，比如說在不同環境下我們的Logstash服務地址是不一樣的，我們就可以把該地址定義在application.yml來使用。

例如在application-dev.yml中定義了這些屬性：

1. logstash:

2. host: localhost

在logback-spring.xml中就可以直接這樣使用：

1. <!--應用名稱-->

2. <springProperty scope="context" name="APP_NAME" source="spring.application.name" defaultValue="springBoot"/>

3. <!--LogStash訪問host-->

4. <springProperty name="LOG_STASH_HOST" scope="context" source="logstash.host" defaultValue="localhost"/>

filter

在Logback中有兩種不同的過濾器，用來過濾日誌輸出。

ThresholdFilter：臨界值過濾器，過濾掉低於指定臨界值的日誌，比如下面的配置將過濾掉所有低於INFO級別的日誌。

1. <filter class="ch.qos.logback.classic.filter.ThresholdFilter">

2. <level>INFO</level>

3. </filter>

LevelFilter：級別過濾器，根據日誌級別進行過濾，比如下面的配置將過濾掉所有非ERROR級別的日誌。

1. <filter class="ch.qos.logback.classic.filter.LevelFilter">

2. <level>ERROR</level>

3. <onMatch>ACCEPT</onMatch>

4. <onMismatch>DENY</onMismatch>

5. </filter>

appender

Appender可以用來控制日誌的輸出形式，主要有下面三種。

• ConsoleAppender：控制日誌輸出到控制檯的形式，比如在console-appender.xml中定義的預設控制檯輸出。

1. <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">

2. <encoder>

3. <pattern>${CONSOLE_LOG_PATTERN}</pattern>

4. </encoder>

5. </appender>

• RollingFileAppender：控制日誌輸出到檔案的形式，可以控制日誌檔案生成策略，比如檔名稱格式、超過多大重新生成檔案以及刪除超過多少天的檔案。

1. <!--ERROR日誌輸出到檔案-->

2. <appender name="FILE_ERROR"

3. class="ch.qos.logback.core.rolling.RollingFileAppender">

4. <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">

5. <!--設定檔案命名格式-->

6. <fileNamePattern>${LOG_FILE_PATH}/error/${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>

7. <!--設定日誌檔案大小，超過就重新生成檔案，預設10M-->

8. <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>

9. <!--日誌檔案保留天數，預設30天-->

10. <maxHistory>${LOG_FILE_MAX_HISTORY:-30}</maxHistory>

11. </rollingPolicy>

12. </appender>

• LogstashTcpSocketAppender：控制日誌輸出到Logstash的形式，可以用來配置Logstash的地址、訪問策略以及日誌的格式。

1. <!--ERROR日誌輸出到LogStash-->

2. <appender name="LOG_STASH_ERROR" class="net.logstash.logback.appender.LogstashTcpSocketAppender">

3. <destination>${LOG_STASH_HOST}:4561</destination>

4. <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">

5. <providers>

6. <timestamp>

7. <timeZone>Asia/Shanghai</timeZone>

8. </timestamp>

9. <!--自定義日誌輸出格式-->

10. <pattern>

11. <pattern>

12. {

13. "project": "mall-tiny",

14. "level": "%level",

15. "service": "${APP_NAME:-}",

16. "pid": "${PID:-}",

17. "thread": "%thread",

18. "class": "%logger",

19. "message": "%message",

20. "stack_trace": "%exception{20}"

21. }

22. </pattern>

23. </pattern>

24. </providers>

25. </encoder>

26. <!--當有多個LogStash服務時，設定訪問策略為輪詢-->

27. <connectionStrategy>

28. <roundRobin>

29. <connectionTTL>5 minutes</connectionTTL>

30. </roundRobin>

31. </connectionStrategy>

32. </appender>

logger

只有配置到logger節點上的appender才會被使用，logger用於配置哪種條件下的日誌被列印，root是一種特殊的appender，下面介紹下日誌劃分的條件。

• 除錯日誌：所有的DEBUG級別以上日誌；
• 錯誤日誌：所有的ERROR級別日誌；
• 業務日誌：com.macro.mall包下的所有DEBUG級別以上日誌；
• 記錄日誌：com.macro.mall.tiny.component.WebLogAspect類下所有DEBUG級別以上日誌，該類是統計介面訪問資訊的AOP切面類。

控制框架輸出日誌

還有一些使用框架內部的日誌，DEBUG級別的日誌對我們並沒有啥用處，都可以設定為了INFO以上級別。

1. <!--控制框架輸出日誌-->

2. <logger name="org.slf4j" level="INFO"/>

3. <logger name="springfox" level="INFO"/>

4. <logger name="io.swagger" level="INFO"/>

5. <logger name="org.springframework" level="INFO"/>

6. <logger name="org.hibernate.validator" level="INFO"/>

Logstash配置詳解

接下來我們需要配置下Logstash，讓它可以分場景收集不同的日誌，下面詳細介紹下使用到的配置。

完全配置

1. input {

2. tcp {

3. mode => "server"

4. host => "0.0.0.0"

5. port => 4560

6. codec => json_lines

7. type => "debug"

8. }

9. tcp {

10. mode => "server"

11. host => "0.0.0.0"

12. port => 4561

13. codec => json_lines

14. type => "error"

15. }

16. tcp {

17. mode => "server"

18. host => "0.0.0.0"

19. port => 4562

20. codec => json_lines

21. type => "business"

22. }

23. tcp {

24. mode => "server"

25. host => "0.0.0.0"

26. port => 4563

27. codec => json_lines

28. type => "record"

29. }

30. }

31. filter{

32. if [type] == "record" {

33. mutate {

34. remove_field => "port"

35. remove_field => "host"

36. remove_field => "@version"

37. }

38. json {

39. source => "message"

40. remove_field => ["message"]

41. }

42. }

43. }

44. output {

45. elasticsearch {

46. hosts => ["es:9200"]

47. action => "index"

48. codec => json

49. index => "mall-tiny-%{type}-%{+YYYY.MM.dd}"

50. template_name => "mall-tiny"

51. }

52. }

配置要點

• input：使用不同埠收集不同型別的日誌，從4560~4563開啟四個埠；
• filter：對於記錄型別的日誌，直接將JSON格式的message轉化到source中去，便於搜尋檢視；
• output：按型別、時間自定義索引格式。

SpringBoot配置

在SpringBoot中的配置可以直接用來覆蓋Logback中的配置，比如logging.level.root就可以覆蓋<root>節點中的level配置。

• 開發環境配置：application-dev.yml

1. logstash:

2. host: localhost

3. logging:

4. level:

5. root: debug

• 測試環境配置：application-test.yml

1. logstash:

2. host: 192.168.3.101

3. logging:

4. level:

5. root: debug

• 生產環境配置：application-prod.yml

1. logstash:

2. host: logstash-prod

3. logging:

4. level:

5. root: info

Kibana進階使用

進過上面ELK環境的搭建和配置以後，我們的日誌收集系統終於可以用起來了，下面介紹下在Kibana中的使用技巧！

• 首先啟動我們的測試Demo，然後通用呼叫介面（可以使用Swagger），產生一些日誌資訊；

​

• 呼叫完成後在Management->Kibana->Index Patterns中可以建立Index Patterns，Kibana服務訪問地址：http://192.168.3.101:5601

​

• 建立完成後可以在Discover中檢視所有日誌，除錯日誌只需直接檢視mall-tiny-debug*模式的日誌即可；

​

• 對於日誌搜尋，kibana有非常強大的提示功能，可以通過搜尋欄右側的Options按鈕開啟；

​

• 記錄日誌只需直接檢視mall-tiny-record*模式的日誌即可，如果我們想要搜尋uri為/brand/listAll的記錄日誌，只需在搜尋欄中輸入uri : "/brand/listAll"；

​

• 錯誤日誌，只需直接檢視mall-tiny-error*模式的日誌即可；

​

• 業務日誌，只需直接檢視mall-tiny-business*模式的日誌即可，這裡我們可以檢視一些SQL日誌的輸出；

​

• 如果日誌太大了，可以通過Elasticsearch->Index Management選擇刪除即可。

​

專案原始碼地址

​