minbox-logging鏈路日志分析框架

Minbox Logging?是一款分布式、零侵入式的鏈路日志分析框架，支持 SpringCloud?微服務(wù)架構(gòu)下配置使用，內(nèi)部封裝了 RestTemplate、OpenFeign?兩種方式透傳鏈路信息。

零侵入式

MinBoxLogging無需使用注解配置采集鏈路日志，只需要添加 依賴后簡單配置 MinboxLogginAdmin的相關(guān) 地址或 服務(wù)名稱即可，每次在收到請求時(shí)就會(huì)把請求對應(yīng)的鏈路日志詳細(xì)信息自動(dòng)上報(bào)到 MinBoxLoggingAdmin進(jìn)行后續(xù)分析、告警通知等。

鏈路日志分析圖

日志客戶端

鏈路日志的采集端，也就是具體的業(yè)務(wù)服務(wù)，只需要添加 minbox-logging-client客戶端進(jìn)行簡單的配置就可以實(shí)現(xiàn)日志的采集以及日志的異步上報(bào)。

日志管理端

對外提供 安全的日志上報(bào)功能，通過整合 SpringSecurity來完成 BasicAuth基礎(chǔ)認(rèn)證，管理端接收到采集端上報(bào)的日志后會(huì)自動(dòng)將日志存儲(chǔ)到數(shù)據(jù)庫，考慮到擴(kuò)展方便，同樣也提供監(jiān)聽 日志上報(bào)事件(ReportLogEvent)的方式來自定義存儲(chǔ)日志到 消息隊(duì)列、 logstash、 文件等存儲(chǔ)介質(zhì)。

日志管理界面

MinBoxLoggingAdmin提供了界面管理應(yīng)用程序，通過 VUE前端框架進(jìn)行編寫界面與管理端的接口通訊，實(shí)時(shí)展示 鏈路日志、 日志采集服務(wù)列表等信息，可查看每條鏈路日志的詳細(xì)信息（包含：請求頭、請求參數(shù)、響應(yīng)內(nèi)容、響應(yīng)頭、狀態(tài)碼、異常堆棧信息等）。

整合 Spring Security 后的登錄界面

可以直接整合 SpringSecurity來完成 Basic安全認(rèn)證。

上報(bào)日志的服務(wù)列表

請求日志的采集服務(wù)在第一次上報(bào)時(shí)，會(huì)自動(dòng)創(chuàng)建一條服務(wù)記錄，服務(wù)的唯一性是根據(jù)： 服務(wù)ID + 服務(wù)IP + 服務(wù)端Port 來進(jìn)行定義。

在每次上報(bào)日志成功后會(huì)修改服務(wù)的最后一次上報(bào)時(shí)間。

鏈路日志列表

鏈路日志是我們訪問的入口服務(wù)生成，比如： bff-user -> user-service，鏈路日志產(chǎn)生的位置則是 bff-user服務(wù)，鏈路日志是接口 請求的入口也是做出 響應(yīng)的結(jié)束位置，因此我們可以在頁面上查看接口的請求 參數(shù)詳情、 頭信息以及 響應(yīng)的內(nèi)容，至于鏈路日志內(nèi)的 日志單元目前界面還未做展示，可以根據(jù) traceId鏈路日志編號自行去數(shù)據(jù)庫查詢。

鏈路日志詳情

每一個(gè)請求的鏈路日志都會(huì)包含上圖中的全部字段，從請求開始 -> 響應(yīng)結(jié)束一條鏈路閉合記錄。

安全性

MinBoxLoggingAdminUI內(nèi)部提供了 login.html登錄頁面，可以整合 SpringSecurity通過配置 loginPageUrl登錄跳轉(zhuǎn)地址來使用內(nèi)置的登錄頁面，當(dāng)然也可以自定義登錄頁面。

可與 MinBoxLoggingAdmin共同使用 SpringSecurity的相同配置提升安全性。

文檔

當(dāng)前版本的文檔，請?jiān)L問?Wikis

快速開始

請?jiān)L問快速開始的 wikis文檔來查看并快速接入 MinBoxLogging，快速接入文檔

源碼方式構(gòu)建

MinBoxLogging使用 Maven進(jìn)行構(gòu)建項(xiàng)目。

先決條件

源碼拉取需使用 Git，具體使用方式詳見安裝 Git

源碼采用 JDK1.8版本進(jìn)行編寫，請注意修改使用項(xiàng)目的 JDK版本，JDK 1.8下載地址

需本地安裝 Maven環(huán)境，Maven 下載地址

因 logging-admin-ui所需 vue-cli-service命令支持，本地需要安裝 vue-cli。

拉取源碼到本地

git clone git@gitee.com:minbox-projects/minbox-logging.git

安裝到本地Maven倉庫

mvn install

編譯 & 打包生成 jar 包

mvn clean package

Maven倉庫依賴構(gòu)建

MinBoxLogging內(nèi)的模塊都已經(jīng)上傳到 ApacheMavenCenter中央倉庫，添加對應(yīng)的依賴到 pom.xml會(huì)自動(dòng)下載到本地。

歡迎提交貢獻(xiàn)代碼

MinBoxLogging歡迎廣大開發(fā)者創(chuàng)建 PullRequest來貢獻(xiàn)代碼，代碼通過審核后會(huì)被合并到 master主分支。