Spring Boot微服务如何在GCP Cloud Logging中添加应用名称

要解决多个微服务日志无法区分来源的问题，核心是给每个微服务的日志打上唯一的应用名称标识，下面是具体实现步骤：

1. 给每个微服务配置唯一应用名 #

在每个微服务的application.yml（或application.properties）中设置专属的应用名称：

spring:
  application:
    name: user-service # 替换为对应微服务的名称，比如order-service、pay-service等

2. 自定义Logback配置，给Stackdriver日志添加应用名字段 #

修改logback-spring.xml，不再直接引用默认的logback-appender.xml，而是自定义STACKDRIVER Appender，将应用名作为自定义字段注入日志：

<configuration>
    <!-- 引入Spring Boot默认日志配置 -->
    <include resource="org.springframework.boot.logging.logback.defaults.xml"/>
    
    <!-- 获取spring.application.name作为全局变量 -->
    <springProperty scope="context" name="springAppName" source="spring.application.name" defaultValue="unknown-app"/>

    <!-- 自定义控制台Appender（可选，本地调试时显示应用名） -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg | app_name:${springAppName}%n</pattern>
        </encoder>
    </appender>

    <!-- 自定义Stackdriver Appender，添加应用名字段 -->
    <appender name="STACKDRIVER" class="org.springframework.cloud.gcp.logging.StackdriverAppender">
        <encoder class="org.springframework.cloud.gcp.logging.StackdriverJsonEncoder">
            <!-- 将应用名作为自定义字段加入JSON日志 -->
            <customFields>{"app_name": "${springAppName}"}</customFields>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
    </appender>

    <include resource="org.springframework.cloud.gcp.logging.logback-json-appender.xml"/>

    <springProfile name="dev">
        <root level="INFO">
            <appender-ref ref="CONSOLE"/>
            <!-- <appender-ref ref="CONSOLE_JSON"/> -->
        </root>
    </springProfile>

    <springProfile name="prod">
        <root level="INFO">
            <appender-ref ref="CONSOLE"/>
            <!-- <appender-ref ref="CONSOLE_JSON"/> -->
            <appender-ref ref="STACKDRIVER"/>
        </root>
    </springProfile>
</configuration>

3. 验证效果 #

重启微服务后，生产环境上报到GCP Cloud Logging的日志会新增app_name字段，对应每个微服务的配置名称，这样就能快速区分日志所属的微服务。

替代方案：通过MDC注入应用名 #

如果需要在更多日志场景中复用应用名，可以通过代码将应用名放入MDC（映射诊断上下文）：

import org.slf4j.MDC;
import org.springframework.boot.context.event.ApplicationStartedEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class AppNameMdcSetup implements ApplicationListener<ApplicationStartedEvent> {

    private final Environment env;

    public AppNameMdcSetup(Environment env) {
        this.env = env;
    }

    @Override
    public void onApplicationEvent(ApplicationStartedEvent event) {
        String appName = env.getProperty("spring.application.name", "unknown-app");
        MDC.put("app_name", appName);
    }
}

之后在Logback的encoder中使用%X{app_name}即可引用这个字段，比如控制台pattern改为：

<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg | app_name:%X{app_name}%n</pattern>

内容的提问来源于stack exchange，提问作者Ravi Soni