javascript
Spring Boot中使用Actuator的/info端点输出Git版本信息
對于Spring Boot的Actuator模塊相信大家已經不陌生了,尤其對于其中的/health、/metrics等強大端點已經不陌生(如您還不了解Actuator模塊,建議先閱讀《Spring Boot Actuator監控端點小結》)。但是,其中還有一個比較特殊的端點/info經常被大家所忽視,因為從最初的理解,它主要用來輸出application.properties配置文件中通過info前綴來定義的一些屬性,由于乍看之下可能想不到太多應用場景,只是被用來暴露一些應用的基本信息,而基本信息本身也可以在與Spring Cloud結合時作為服務治理的注冊信息統一管理,所以這個端點的用處并不是很大。
然而實際上,該端點除了描述應用信息之外,也還可以用來描述Git版本信息,并且整合方法非常簡單,下面我們就來看看如何使用/info端點暴露當前應用的Git版本信息。
POM配置
首先,我們可以挑選任意一個Spring Boot項目,修改它的pom.xml:
- 引入spring-boot-starter-actuator,提供/info端點
| <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> |
- 添加git-commit-id-plugin插件,該插件用來產生git的版本信息
| <plugin> <groupId>pl.project13.maven</groupId> <artifactId>git-commit-id-plugin</artifactId> <version>2.1.15</version> <executions> <execution> <goals> <goal>revision</goal> </goals> </execution> </executions> <configuration> <dotGitDirectory>${project.basedir}/.git</dotGitDirectory> </configuration> </plugin> |
產生git版本信息
- 在完成了上面的配置之后,執行git-commit-id-plugin插件
運行完成后,我們可以在控臺中看到類似下面的信息:
| [INFO] pl.project13.maven.git.log.MavenLoggerBridge - dotGitDirectory E:\git_project\oschina\SpringBoot-Learning\.git [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.build.user.name didi [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.build.user.email dyc87112@qq.com [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.branch master [INFO] pl.project13.maven.git.log.MavenLoggerBridge - --always = true [INFO] pl.project13.maven.git.log.MavenLoggerBridge - --dirty = -dirty [INFO] pl.project13.maven.git.log.MavenLoggerBridge - --abbrev = 7 [INFO] pl.project13.maven.git.log.MavenLoggerBridge - Tag refs [ [Ref[refs/tags/chapter1=ec8713f61cd49569886708a08adea02c8ef0a112]] ] [INFO] pl.project13.maven.git.log.MavenLoggerBridge - Created map: [ {} ] [INFO] pl.project13.maven.git.log.MavenLoggerBridge - HEAD is [ e0540b3524378de9b5d938668a0f75ec016fa5e5 ] [INFO] pl.project13.maven.git.log.MavenLoggerBridge - Repo is in dirty state [ true ] [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.commit.id.describe e0540b3-dirty [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.commit.id e0540b3524378de9b5d938668a0f75ec016fa5e5 [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.commit.id.abbrev e0540b3 [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.dirty true ... |
同時,在target/classes目錄下,我們可以發現產生了一個git.properties配置信息:
這個文件就是當前項目的git信息,它的內容如下:
| #Generated by Git-Commit-Id-Plugin #Thu Jun 01 17:57:53 CST 2017 git.build.user.email=dyc87112@qq.com git.build.host=Lenovo-zhaiyc git.dirty=true git.remote.origin.url=https\://git.oschina.net/didispace/SpringBoot-Learning.git git.closest.tag.name=chapter1 git.commit.id.describe-short=e0540b3-dirty git.commit.user.email=dyc87112@qq.com git.commit.time=2017-06-01T17\:57\:10+0800 git.commit.message.full=update git.build.version=1.0.0 git.commit.message.short=update git.commit.id.abbrev=e0540b3 git.branch=master git.build.user.name=didi git.closest.tag.commit.count=240 git.commit.id.describe=e0540b3-dirty git.commit.id=e0540b3524378de9b5d938668a0f75ec016fa5e5 git.tags= git.build.time=2017-06-01T17\:57\:53+0800 git.commit.user.name=didi |
啟動測試
完成了上述配置之后,啟動應用并訪問端點,比如:curl localhost:8080/info,我們可以獲得如下輸出:
| { "git": { "commit": { "time": 1496311030000, "id": "e0540b3" }, "branch": "master" } } |
其中包含了關于branch和commit的基礎信息。而這個信息格式是最簡模式,我們也可以通過配置下面的參數來獲取更全面的git信息:
| management.info.git.mode=full |
重啟應用后再訪問/info端點,可以獲得類似下面更為詳細的版本信息了。
| { "git": { "build": { "host": "Lenovo-zhaiyc", "version": "1.0.0", "time": 1496311073000, "user": { "name": "didi", "email": "dyc87112@qq.com" } }, "branch": "master", "commit": { "message": { "short": "update", "full": "update" }, "id": "e0540b3524378de9b5d938668a0f75ec016fa5e5", "id.describe-short": "e0540b3-dirty", "id.abbrev": "e0540b3", "id.describe": "e0540b3-dirty", "time": 1496311030000, "user": { "email": "dyc87112@qq.com", "name": "didi" } }, "closest": { "tag": { "name": "chapter1", "commit": { "count": "240" } } }, "dirty": "true", "remote": { "origin": { "url": "https://git.oschina.net/didispace/SpringBoot-Learning.git" } }, "tags": "" } } |
代碼示例
本文的相關例子可以查看下面倉庫中的Chapter6-2-1目錄:
- Github:https://github.com/dyc87112/SpringBoot-Learning
- Gitee:https://gitee.com/didispace/SpringBoot-Learning
相關閱讀
- Spring Boot Actuator監控端點小結
- 在傳統Spring應用中使用spring-boot-actuator模塊提供監控端點
- 使用Spring Boot Actuator、Jolokia和Grafana實現準實時監控
總結
以上是生活随笔為你收集整理的Spring Boot中使用Actuator的/info端点输出Git版本信息的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: HDFS NameNode内存详解
- 下一篇: OpenTSDB 造成 Hbase 整点