如何在Logback LogstashSocketAppender的JSON输出中包含环境变量

当然可以！你完全能把环境变量的值嵌入到每条JSON格式的日志里，下面给你两种实用的实现方式，结合你的示例配置来调整：

方法1：通过LoggingEventPatternJsonProvider直接引用环境变量 #

Logback本身支持用${环境变量名}的语法读取环境变量，所以你可以直接在JSON pattern里替换掉你的???部分，示例配置如下：

<appender name="SOCKET" class="net.logstash.logback.appender.LogstashSocketAppender">
    <host>127.0.0.1</host>
    <port>1511</port>
    <provider class="net.logstash.logback.composite.loggingevent.LoggingEventPatternJsonProvider">
        <pattern>
            {
                "foo": "${FOO}",
                "level": "%level",
                "message": "%message"
                <!-- 可根据需求添加更多日志字段 -->
            }
        </pattern>
    </provider>
</appender>

如果担心环境变量FOO不存在导致报错，还可以设置默认值：${FOO:-unknown}，这样当变量未定义时会用unknown填充。

方法2：使用EnvironmentJsonProvider（更简洁的推荐方案） #

logstash-logback-encoder库提供了专门的EnvironmentJsonProvider，可以批量添加环境变量，或者指定要包含的变量名，配置更整洁：

<appender name="SOCKET" class="net.logstash.logback.appender.LogstashSocketAppender">
    <host>127.0.0.1</host>
    <port>1511</port>
    <!-- 先添加默认的日志字段提供者（比如级别、消息等） -->
    <provider class="net.logstash.logback.composite.loggingevent.LoggingEventJsonProvider"/>
    <!-- 添加环境变量提供者，指定要包含的变量 -->
    <provider class="net.logstash.logback.composite.loggingevent.EnvironmentJsonProvider">
        <!-- 只添加指定的环境变量 -->
        <includes>
            <include>FOO</include>
            <!-- 可按需添加更多变量，比如BAR -->
        </includes>
        <!-- 可选：给环境变量添加统一前缀，比如env_，输出的字段名会变成env_FOO -->
        <!-- <fieldPrefix>env_</fieldPrefix> -->
    </provider>
</appender>

这种方式不需要手动编写JSON结构，库会自动把指定的环境变量作为字段加入到日志JSON中，后续维护起来更方便。

注意事项 #

• 确保你的项目中引入了正确版本的logstash-logback-encoder依赖，上述Provider都是这个库提供的；
• 如果是Spring Boot项目，也可以结合Spring的配置属性，但上面的方式是纯Logback配置，通用性更强。

内容的提问来源于stack exchange，提问作者Dan Tanner