如何将Logback自定义字段发送至Azure AppInsights？

要让StructuredArguments中的自定义字段出现在Azure AppInsights的traces表中，核心是让Logback输出包含结构化参数的JSON格式日志，同时配置AppInsights的Logback适配器正确解析这些内容。具体步骤如下：

1. 添加必要依赖 #

确保项目中包含以下两个依赖（以Maven为例，版本选择与你的Azure SDK兼容的最新版）：

<!-- 用于处理结构化日志转JSON -->
<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>7.4</version>
</dependency>
<!-- Azure AppInsights的Logback适配器 -->
<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>applicationinsights-logback-appender</artifactId>
    <version>2.6.4</version>
</dependency>

2. 修改Logback配置文件 #

在logback.xml（或logback-spring.xml）中配置AppInsights appender，使用LoggingEventCompositeJsonLayout来将结构化参数转为JSON字段：

<appender name="APP_INSIGHTS" class="com.microsoft.azure.applicationinsights.logback.ApplicationInsightsAppender">
    <!-- 使用Logstash的JSON布局编码器 -->
    <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
        <layout class="net.logstash.logback.layout.LoggingEventCompositeJsonLayout">
            <providers>
                <!-- 保留基础日志字段 -->
                <timestamp/>
                <message/>
                <loggerName/>
                <level/>
                <!-- 关键：自动解析StructuredArguments中的键值对 -->
                <structuredArguments/>
            </providers>
        </layout>
    </encoder>
</appender>

<!-- 将root logger指向该appender -->
<root level="info">
    <appender-ref ref="APP_INSIGHTS"/>
</root>

3. 验证效果 #

运行你的代码后，Azure AppInsights的traces表中，对应日志条目的customDimensions字段会包含testKey: testValue这样的自定义键值对。

补充说明 #

• 如果不想引入logstash依赖，也可以手动在PatternLayout中指定提取结构化参数，比如%X{testKey}，但这种方式需要提前知道所有自定义键的名称，灵活性较差。
• 确保你的AppInsights连接字符串已正确配置（通过环境变量APPLICATIONINSIGHTS_CONNECTION_STRING或配置文件中的instrumentationKey）。

内容的提问来源于stack exchange，提问作者Sebastian Dusza