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 [email protected]

[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

[email protected]

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

[email protected]

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": "[email protected]"

}

},

"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": "[email protected]",

"name": "didi"

}

},

"closest": {

"tag": {

"name": "chapter1",

"commit": {

"count": "240"

}

}

},

"dirty": "true",

"remote": {

"origin": {

"url": "https://git.oschina.net/didispace/SpringBoot-Learning.git"

}

},

"tags": ""

}

}

时间: 2024-08-02 02:49:32

Spring Boot中使用Actuator的/info端点输出Git版本信息的相关文章

传统的Servlet在spring boot中怎么实现的?

本文主要内容: 1:springboot一些介绍 2:传统的servlete项目在spring boot项目中怎么实现的?web.xml.url-patterns怎么设置? 3:有几种实现方式?分别是什么? 4:代码位置 spring boot 三大特性 组件自动装配:webMVC.webFlux.JDBC等 嵌入式Web容器:Tomcat.Jetty以及undertow 生产准备特性:指标.健康检查.外部化部署等 组件自动装配: 激活自动装配注解:@EnableAutoConfiguratio

3.Spring Boot中使用Swagger2构建强大的RESTful API文档

原文:http://www.jianshu.com/p/8033ef83a8ed 由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端. 这样一来,我们的RESTful API就有可能要面对多个开发人员或多个开发团队:IOS开发.Android开发或是Web开发

spring-boot实战【10】【转】:Spring Boot中使用@Async实现异步调用

什么是"异步调用"? "异步调用"对应的是"同步调用",同步调用指程序按照定义顺序依次执行,每一行程序都必须等待上一行程序执行完成之后才能执行:异步调用指程序在顺序执行时,不等待异步调用的语句返回结果就执行后面的程序. 同步调用 下面通过一个简单示例来直观的理解什么是同步调用: 定义Task类,创建三个处理函数分别模拟三个执行任务的操作,操作消耗时间随机取(10秒内) 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

spring-boot实战【07】【转】:Spring Boot中Web应用的统一异常处理

我们在做Web应用的时候,请求处理过程中发生错误是非常常见的情况.Spring Boot提供了一个默认的映射:/error,当处理中抛出异常之后,会转到该请求中处理,并且该请求有一个全局的错误页面用来展示异常内容. 选择一个之前实现过的Web应用(Chapter3-1-2)为基础,启动该应用,访问一个不存在的URL,或是修改处理内容,直接抛出异常,如: 1 2 3 4 @RequestMapping("/hello") public String hello() throws Exce

spring-boot实战【09】【转】:Spring Boot中使用@Scheduled创建定时任务

我们在编写Spring Boot应用中经常会遇到这样的场景,比如:我需要定时地发送一些短信.邮件之类的操作,也可能会定时地检查和监控一些标志.参数等. 创建定时任务 在Spring Boot中编写定时任务是非常简单的事,下面通过实例介绍如何在Spring Boot中创建定时任务,实现每过5秒输出一下当前时间. 在Spring Boot的主类中加入@EnableScheduling注解,启用定时任务的配置 1 2 3 4 5 6 7 8 9 10 @SpringBootApplication @E

spring-boot实战【12】:Spring Boot中使用JavaMailSender发送邮件

相信使用过Spring的众多开发者都知道Spring提供了非常好用的JavaMailSender接口实现邮件发送.在Spring Boot的Starter模块中也为此提供了自动化配置.下面通过实例看看如何在Spring Boot中使用JavaMailSender发送邮件. 快速入门 在Spring Boot的工程中的pom.xml中引入spring-boot-starter-mail依赖: 1 2 3 4 <dependency> <groupId>org.springframew

再谈Spring Boot中的乱码和编码问题

编码算不上一个大问题,即使你什么都不管,也有很大的可能你不会遇到任何问题,因为大部分框架都有默认的编码配置,有很多是UTF-8,那么遇到中文乱码的机会很低,所以很多人也忽视了. Spring系列产品大量运用在网站开发中,而Spring Boot是为了简化配置而出现的,理论上讲Spring Boot应该默认配置UTF-8为默认编码,但是网络上依然可以看到很多关于Spring Boot乱码的文章,大部分解决方案沿用Spring MVC的方案,自定义EncodingFilter. 但是仔细查看Spri

Spring Boot中的注解

文章来源:http://www.tuicool.com/articles/bQnMra 在Spring Boot中几乎可以完全弃用xml配置文件,本文的主题是分析常用的注解. Spring最开始是为了解决EJB等大型企业框架对应用程序的侵入性,因此大量依靠配置文件来“非侵入式”得给POJO增加功能,然而,从Spring 3.x开始,Spring被外界最为诟病的一点就是配置繁多,号称“配置地狱”,各种xml文件,出了问题非常难排查.从Spring 4.x开始,Spring.io提供了三种方式编织B

Spring Boot中使用Swagger2生成RESTful API文档(转)

效果如下图所示: 添加Swagger2依赖 在pom.xml中加入Swagger2的依赖 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <versi