如何在Application Insights中跟踪Azure WebJobs(v2.2.0)的自定义事件？

我之前也碰到过WebJobs v2.x里直接实例化TelemetryClient调用TrackEvent没效果的情况，核心问题是WebJobs SDK的Application Insights（AI）集成有特定的配置和依赖注入要求，自己new的客户端无法和SDK的遥测管道关联，导致数据发不出去。下面是具体的解决步骤：

1. 安装正确的NuGet包 #

首先确保你的项目安装了对应WebJobs v2.2.0版本的AI集成包：

Install-Package Microsoft.Azure.WebJobs.Logging.ApplicationInsights -Version 2.2.0

这个包会自动引入所需的Microsoft.ApplicationInsights依赖，确保版本匹配避免兼容性问题。

2. 正确配置JobHost的日志和AI集成 #

在你的Program.cs中，需要在构建HostBuilder时明确配置Application Insights，而不仅仅是常规的WebJobs设置。示例配置如下：

using Microsoft.Azure.WebJobs;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

class Program
{
    static void Main()
    {
        var config = new ConfigurationBuilder()
            .AddJsonFile("appsettings.json", optional: false)
            .AddEnvironmentVariables()
            .Build();

        var builder = new HostBuilder()
            .ConfigureWebJobs(b =>
            {
                b.AddAzureStorageCoreServices();
                // 这里添加你的其他绑定（比如队列、Blob等）配置
            })
            .ConfigureLogging((context, logging) =>
            {
                // 启用Application Insights日志和遥测
                logging.AddApplicationInsights(aiConfig =>
                {
                    aiConfig.InstrumentationKey = config["APPINSIGHTS_INSTRUMENTATIONKEY"];
                    // 测试期间可以禁用采样，避免事件被过滤
                    aiConfig.SamplingSettings.IsEnabled = false;
                });
                // 设置日志级别，确保AI能捕获到所需的日志
                logging.AddFilter<Microsoft.Extensions.Logging.ApplicationInsights.ApplicationInsightsLoggerProvider>("", LogLevel.Information);
            })
            .UseConfiguration(config)
            .Build();

        builder.Run();
    }
}

同时在appsettings.json中添加AI的Instrumentation Key：

{
  "APPINSIGHTS_INSTRUMENTATIONKEY": "你的AI仪表板密钥"
}

3. 通过依赖注入获取TelemetryClient（关键！） #

不要自己手动new TelemetryClient()，WebJobs SDK会管理TelemetryClient的生命周期，并自动关联作业的上下文（比如Invocation ID、Job名称等）。你需要通过构造函数注入的方式在你的Job函数类中获取客户端：

using Microsoft.ApplicationInsights;
using Microsoft.Azure.WebJobs;
using Microsoft.Extensions.Logging;
using System.Collections.Generic;

public class MyFunctions
{
    private readonly TelemetryClient _telemetryClient;

    // 构造函数注入TelemetryClient
    public MyFunctions(TelemetryClient telemetryClient)
    {
        _telemetryClient = telemetryClient;
    }

    public void ProcessQueueItem([QueueTrigger("my-queue")] string item, ILogger logger)
    {
        // 现在调用TrackEvent就能正常发送到AI了
        var eventProperties = new Dictionary<string, string>
        {
            { "QueueItemContent", item },
            { "ProcessingStatus", "Started" }
        };
        _telemetryClient.TrackEvent("QueueItemProcessingStarted", eventProperties);

        logger.LogInformation("Processing queue item: {Item}", item);
        
        // 业务逻辑...

        _telemetryClient.TrackEvent("QueueItemProcessingCompleted", eventProperties);
    }
}

4. 验证配置和排查问题 #

如果还是没看到事件：

• 检查AI仪表板的实时指标流，这里能更快看到是否有遥测数据进来（比日志搜索快）
• 确保你的WebJobs运行时能访问AI的端点（如果是本地运行，检查防火墙设置；如果是Azure上的WebJobs，确保网络配置允许出站请求）
• 暂时禁用采样（步骤2中的配置），避免采样规则过滤掉你的测试事件
• 查看WebJobs的日志，是否有AI相关的错误信息

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