Spring Boot中使用Actuator的/info端点输出Git版本信息
创始人
2025-02-13 02:30:12
0

对于Spring   Boot中的 Actuator 模块相信大家早已经不陌生了,尤其是对于其中的/health、/metrics等强大端点已经不陌生。但是,其中还有一个比较特殊的端点/info经常被大家所忽视,因为从最初的理解,它主要用来输出application.properties配置文件中通过info前缀来定义的一些属性,由于乍看之下可能想不到太多应用场景,只是被用来暴露一些应用的基本信息,而基本信息本身也可以在与Spring Cloud结合时作为服务治理的注册信息统一管理,所以这个端点的用处并不是很大。

然而实际上,该端点除了描述应用信息之外,也还可以用来描述Git版本信息,并且整合方法非常简单,下面我们就来看看如何使用/info端点暴露当前应用的Git版本信息。

POM配置

首先,我们可以挑选任意一个Spring Boot项目,修改它的pom.xml。引入spring-boot-starter-actuator,提供/info端点:

  1.  
  2.     org.springframework.boot 
  3.     spring-boot-starter-actuator 
  4.  

添加git-commit-id-plugin插件,该插件用来产生git的版本信息:

  1.  
  2.     pl.project13.maven 
  3.     git-commit-id-plugin 
  4.     2.1.15 
  5.      
  6.          
  7.              
  8.                 revision 
  9.              
  10.          
  11.      
  12.      
  13.         ${project.basedir}/.git 
  14.      
  15.  

产生git版本信息

在完成了上面的配置之后,执行git-commit-id-plugin插件。

产生git版本信息

运行完成后,我们可以在控台中看到类似下面的信息:

  1. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - dotGitDirectory E:\git_project\oschina\SpringBoot-Learning\.git 
  2. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.build.user.name didi 
  3. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.build.user.email dyc87112@qq.com 
  4. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.branch master 
  5. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - --always = true 
  6. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - --dirty = -dirty 
  7. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - --abbrev = 7 
  8. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - Tag refs [ [Ref[refs/tags/chapter1=ec8713f61cd49569886708a08adea02c8ef0a112]] ] 
  9. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - Created map: [ {} ] 
  10. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - HEAD is [ e0540b3524378de9b5d938668a0f75ec016fa5e5 ] 
  11. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - Repo is in dirty state [ true ] 
  12. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.commit.id.describe e0540b3-dirty 
  13. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.commit.id e0540b3524378de9b5d938668a0f75ec016fa5e5 
  14. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.commit.id.abbrev e0540b3 
  15. [INFO] pl.project13.maven.git.log.MavenLoggerBridge - git.dirty true 
  16. ... 

同时,在target/classes目录下,我们可以发现产生了一个git.properties配置信息。

这个文件就是当前项目的git信息,它的内容如下:

  1. #Generated by Git-Commit-Id-Plugin 
  2. #Thu Jun 01 17:57:53 CST 2017 
  3. git.build.user.email=dyc87112@qq.com 
  4. git.build.host=Lenovo-zhaiyc 
  5. git.dirty=true 
  6. git.remote.origin.url=https\://git.oschina.net/didispace/SpringBoot-Learning.git 
  7. git.closest.tag.name=chapter1 
  8. git.commit.id.describe-short=e0540b3-dirty 
  9. git.commit.user.email=dyc87112@qq.com 
  10. git.commit.time=2017-06-01T17\:57\:10+0800 
  11. git.commit.message.full=update 
  12. git.build.version=1.0.0 
  13. git.commit.message.short=update 
  14. git.commit.id.abbrev=e0540b3 
  15. git.branch=master 
  16. git.build.user.name=didi 
  17. git.closest.tag.commit.count=240 
  18. git.commit.id.describe=e0540b3-dirty 
  19. git.commit.id=e0540b3524378de9b5d938668a0f75ec016fa5e5 
  20. gitgit.tags= 
  21. git.build.time=2017-06-01T17\:57\:53+0800 
  22. git.commit.user.name=didi 

启动测试

完成了上述配置之后,启动应用并访问端点,比如:curl localhost:8080/info,我们可以获得如下输出:

  1.     "git": { 
  2.         "commit": { 
  3.             "time": 1496311030000, 
  4.             "id": "e0540b3" 
  5.         }, 
  6.         "branch": "master" 
  7.     } 

其中包含了关于branch和commit的基础信息。而这个信息格式是最简模式,我们也可以通过配置下面的参数来获取更全面的git信息:

  1. management.info.git.mode=full 

重启应用后再访问/info端点,可以获得类似下面更为详细的版本信息了。

  1.   "git": { 
  2.     "build": { 
  3.       "host": "Lenovo-zhaiyc", 
  4.       "version": "1.0.0", 
  5.       "time": 1496311073000, 
  6.       "user": { 
  7.         "name": "didi", 
  8.         "email": "dyc87112@qq.com" 
  9.       } 
  10.     }, 
  11.     "branch": "master", 
  12.     "commit": { 
  13.       "message": { 
  14.         "short": "update", 
  15.         "full": "update" 
  16.       }, 
  17.       "id": "e0540b3524378de9b5d938668a0f75ec016fa5e5", 
  18.       "id.describe-short": "e0540b3-dirty", 
  19.       "id.abbrev": "e0540b3", 
  20.       "id.describe": "e0540b3-dirty", 
  21.       "time": 1496311030000, 
  22.       "user": { 
  23.         "email": "dyc87112@qq.com", 
  24.         "name": "didi" 
  25.       } 
  26.     }, 
  27.     "closest": { 
  28.       "tag": { 
  29.         "name": "chapter1", 
  30.         "commit": { 
  31.           "count": "240" 
  32.         } 
  33.       } 
  34.     }, 
  35.     "dirty": "true", 
  36.     "remote": { 
  37.       "origin": { 
  38.         "url": "https://git.oschina.net/didispace/SpringBoot-Learning.git" 
  39.       } 
  40.     }, 
  41.     "tags": "" 
  42.   } 

【本文为51CTO专栏作者“翟永超”的原创稿件,转载请通过51CTO联系作者获取授权】

戳这里,看该作者更多好文

相关内容

热门资讯

PHP新手之PHP入门 PHP是一种易于学习和使用的服务器端脚本语言。只需要很少的编程知识你就能使用PHP建立一个真正交互的...
各种千兆交换机的数据接口类型详... 千兆交换机有很多值得学习的地方,这里我们主要介绍各种千兆交换机的数据接口类型,作为局域网的主要连接设...
网络中立的未来 网络中立性是什... 《牛津词典》中对“网络中立”的解释是“电信运营商应秉持的一种原则,即不考虑来源地提供所有内容和应用的...
什么是大数据安全 什么是大数据... 在《为什么需要大数据安全分析》一文中,我们已经阐述了一个重要观点,即:安全要素信息呈现出大数据的特征...
如何允许远程连接到MySQL数... [[277004]]【51CTO.com快译】默认情况下,MySQL服务器仅侦听来自localhos...
如何利用交换机和端口设置来管理... 在网络管理中,总是有些人让管理员头疼。下面我们就将介绍一下一个网管员利用交换机以及端口设置等来进行D...
施耐德电气数据中心整体解决方案... 近日,全球能效管理专家施耐德电气正式启动大型体验活动“能效中国行——2012卡车巡展”,作为该活动的...
Windows恶意软件20年“... 在Windows的早期年代,病毒游走于系统之间,偶尔删除文件(但被删除的文件几乎都是可恢复的),并弹...
范例解读VB.NET获取环境变... VB.NET编程语言的使用范围非常广泛,可以帮助开发人员处理各种程序中的需求,而且还能对移动设备进行...
规避非法攻击 用好路由器远程管... 单位在市区不同位置设立了科技服务点,每一个服务点的员工都通过宽带路由器进行共享上网,和单位网络保持联...