如何使用 Spring Boot 将 git commit id 输出到所有 logback 日志？

Question

我正在使用 SpringBoot 和 Logback 以及 git commit id maven 插件。如何配置 logback 和 SpringBoot 以在我的日志输出中包含执行器返回的 git commit id？我希望每一行输出都包含生成该输出行的引导应用程序的 git commit id。

Answer 1

默认情况下，git-commit-id-plugin 在类路径的根目录中创建一个名为 git.properties 的文件，其中包含许多属性，包括 git.commit.id。

您可以在 logback 的配置文件中import these properties，并在 logback 配置中的任何位置访问属性。

例如，您可以在这样的模式中使用它：

<configuration>

    <!-- Expose the properties from the file generated by git-commit-id-plugin -->
    <property resource="git.properties"/>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} ${git.commit.id} - %message%n</pattern>
        </encoder>
    </appender>
    ...
</configuration>

或者（因为您使用logstash-logback-encoder 标记了此问题）您可以通过custom fields 或通过pattern provider 将其包含在JSON 字段中，如下所示：

<configuration>

    <!-- Expose the properties from the file generated by git-commit-id-plugin -->
    <property resource="git.properties"/>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <providers>
                <pattern>
                    <pattern>{"commitId":"${git.commit.id}"}</pattern>
                </pattern>
            ...
            </providers>
        </encoder>
    </appender>
    ...
</configuration>