1. 程式人生 > >在 java 項目中使用 vicrab 實現自動化異常(BUG)管理插件

在 java 項目中使用 vicrab 實現自動化異常(BUG)管理插件

mpi bug admin com 意義 有一種 結構 http pri

一 背景介紹
系統錯誤異常管理是非常重要的系統模塊,在我們的日常開發,測試,線上運營診斷都有著非常強大的做用。然而,傳統的日誌系統都是發生在系統出問題的時候,工程師們去後臺一段一段的翻看日誌,海量的日誌具有一定的不可讀性,給系統運維,排查錯誤帶來了大量的無用工作,有沒有一種方案,可以把系統的錯誤自動收集,自動歸類,以報表的形式把錯誤信息整理出來。vicrab就此誕生。

二 Vicrab 簡介
? vicrab日誌系統是目前非常流行的日誌監控和運維的SASS服務框架, vicrab主要包含了以下幾個部分:
?Vicrab admin:基於雲的sass服務,用戶只需要註冊一個賬號,通過簡單的配置,便可以輕松管理使用自己的應用異常。

?Vicrab SDK :vicrab的客戶端程序。目前vicrab的開發團隊已經上線了vicrab-sdk for java ,vicrab-sdk for android 的兩種客戶端方案,只需要在項目中簡單引入,配置日誌傳輸路徑即可集成完畢。
?Vicrab document:vicrab 的介紹文檔,在github 上和官網都可以下載使用。

三 為什麽要使用 vicrab
當下很多公司都采取傳統的開發模式,前端和後端的工作由不同的工程師完成。在這種開發模式下,維持一份及時更新且完整的 錯誤日誌系統將會極大的提高我們的工作效率。傳統意義上的錯誤都是前端工程師管前端的,後臺開發負責後臺的,當發生異常的時候,大家從前往後查,或者從後往前推的思路,但是錯誤日誌是分散的,而且有些錯誤並不能重現,相信大家也都知道這種方式很難保證錯誤修復的及時性,反而還會加大我們的溝通成本。而 vicrab給我們提供了一個全新的錯誤跟蹤的方式,下面我們就來了解一下它的優點:

?簡化管理,sass服務,在統一的控制臺進行管理。
?集成簡單,只需要簡單的三步就可以完成集成後續無需更改。
?高性能,基於日誌系統的異步實現,性能好,對原系統無影響。
?價格低廉:低廉的使用成本,對企業而言可以忽略不計。

以上這些優點足以說明我們為什麽要使用 vicrab了,您是否已經對 vicrab產生了濃厚的興趣了呢?下面我們就將一步一步地在 Spring Boot 項目中集成和使用 vicrab,讓我們從準備一個 Spring Boot 的 Web 項目開始吧。

四 下載vicrab
vicrab通過在線倉庫的形式進行系統集成,非常方便。

官網地址:
https://www.vicrab.com
在線文檔:

https://github.com/vicrab/vicrab-docs/blob/master/src/clients/java/modules/logback.md

五 選擇合適的vicrab sdk
根據你的系統日誌的實現方式來選擇相應的sdk client 進行集成。查看官網(https://github.com/vicrab/vicrab-docs/blob/master/src/clients/java/index.md)的幫助,目前提供了如下的5種SDK來供大家使用。
?Android?>>?demo
?java.util.logging?>>?demo
?Log4j 1.x?>>?demo
?Log4j 2.x?>>?demo
?Logback?>>?demo
Android客戶端最好選擇,就它一個。而java的服務端會根據你的日誌實現方式來進行選擇,分為原生util log,log4j1 ,log4j2,logback四種形式來進行區分。這幾種形式只是引入的jar包不同,其他步驟都一樣。

集成步驟

vicrab從java6開始提供支持.

1 創建一個賬號。訪問官網開始創建http://vicrab.com.
技術分享圖片

註冊的時候,需要配置你的項目,選擇開發語言,比如java,輸入項目名稱,組織等信息。註冊完成。

2 引入sdk ,此步驟可以參考第5部分介紹,比如log4j1版本

Using Maven:
<dependency>
<groupId>com.vicrab</groupId>
<artifactId>vicrab-log4j</artifactId>
<version>1.1</version>
</dependency>

假如你的項目使用的是springboot框架,那麽需要在另外多引入一個包,體驗更佳。
<dependency>
<groupId>com.vicrab</groupId>
<artifactId>vicrab-spring-boot-starter</artifactId>
<version>1.2</version>
</dependency>

Using Gradle:
compile ‘com.vicrab:vicrab-log4j:1.1‘
Using SBT:
libraryDependencies += "com.vicrab" % "vicrab-log4j" % "1.1"

3 配置使用

   配置DSN和日誌文件(DSN的地址可以在vicrab的控制臺設置裏面提供,每個用戶一個,各自獨立),日誌配置支持properties,xml 兩種格式,具體參考在線手冊。

dsn=https://[email protected]/17841

七 集成案例

在這一步我們將準備一個基礎的 Spring Boot 的項目,結構如下

技術分享圖片

編寫LoggerTest.java類,我們實現一個異常來進行測試。
技術分享圖片

添加依賴:
技術分享圖片
配置DSN和log4j
技術分享圖片

運行起來測試:
技術分享圖片

控制臺查看錯誤
技術分享圖片

八 結束語
本文介紹了vicrab的背景和用途,以及和log4j1的項目的集成方式,通過本篇我們已經對vicrab有了一個大致的認識,還有很多的強大的功能待我們後續去發掘和研究。後續還會有更多更強大的功能分享給大家。比如代碼定位,AI代碼修復等。敬請期待。

九 參考資料

在線文檔 :
https://github.com/vicrab/vicrab-docs/blob/master/src/clients/java/index.md

技術支持郵箱:[email protected]

    https://vicrab.com/about?message=#

在 java 項目中使用 vicrab 實現自動化異常(BUG)管理插件