HelloWood

Spring Boot Actuator 添加 Git 和 Build 信息

2018-01-01

在使用 Spring Boot Actuator 时可以通过生成 Git 和编译文件来提供信息

添加 Git 信息

  • 添加插件

    在 build.gradle 文件中添加一下配置

1
2
3
4
5
6
7
8
9
10
11
12
13
buildscript {
 
    repositories {
        maven { url "https://plugins.gradle.org/m2/" }
    }

    dependencies {
        classpath("gradle.plugin.com.gorylenko.gradle-git-properties:gradle-git-properties:1.4.17")
    }
}

apply plugin: 'com.gorylenko.gradle-git-properties'

这样就会在 build\main\resource\下生成 git.properties文件，该文件内会包含 Git 仓库的信息

  • 其他配置

    build.gradle

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12

    gitProperties {
        // 日期格式
        dateFormat = "yyyy-MM-dd' 'HH:mm:ss"
        // 时区
        dateFormatTimeZone = "PST"
        // 生成的 git.properties 文件位置
        gitPropertiesDir = new File("${project.rootDir}/build/resources/main/")
        // git 文件所在目录
        gitRepositoryRoot = new File("${project.rootDir}/")
    }

添加编译信息

  • 添加配置信息

    在 build.gradle 中添加

1
2
3
4
5
6
7
8
9
10
springBoot {
    buildInfo {
        // 自定义内容
        additionalProperties = [
                'name'   : 'RedisAPI',
                'version': '0.0.1'
        ]
    }
}

会在 build\resources\MATE-INF\ 下生成 build-info.properties 文件

  • 访问 /info
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
    "app": {
        "java": {
            "source": "1.8",
            "target": "1.8"
        },
        "encoding": "UTF-8"
    },
    "version": "Spring Boot application",
    "git": {
        "commit": {
            "message": {
                "full": ":sparkles: Add SpringBoot Admin Server monitor function",
                "short": ":sparkles: Add SpringBoot Admin Server monitor function"
            },
            "time": "2017-09-05T10:57-0700",
            "id": "3bb077a0710e31c2dfc345afdcdb52b9b5846f61",
            "id.abbrev": "3bb077a",
            "user": {
                "email": "xxxx@outlook.com",
                "name": "HelloWood"
            }
        },
        "branch": "master"
    },
    "build": {
        "version": "0.0.1",
        "artifact": "redis",
        "name": "RedisAPI",
        "group": "",
        "time": 1513519543000
    }
}

参考https://docs.spring.io/spring-boot/docs/current/reference/html/howto-build.html#howto-build-info

Tags: SpringBoot Java Actuator
← Tomcat启动时一直停留在一个应用的发布的解决办法 IDEA Maven项目导入失败，无法识别pom文件 →