如何为Service Bus触发的Azure Function向App Insights添加可选参数

问题背景 #

应用包含Service Bus触发的Azure Function与传统API，需为两者的App Insights添加两个可选参数：

• API端已通过ITelemetryInitializer实现，注入HttpContext从Header获取参数值
• Azure Function中无HttpContext，参数可通过Function内的Helper方法获取，要求仅在调用该Helper方法时，将参数添加至App Insights

此前三次尝试均失败：

1. 复用ITelemetryInitializer：Function无HttpContext无法获取参数
2. 手动创建RequestTelemetry并调用Add()：属性未附加到Function的默认遥测中
3. 修改TelemetryClient.Context.GlobalProperties：属性未出现在正确的遥测条目里

问题根源分析 #

1. 手动创建TelemetryConfiguration：自行实例化的配置未与Function runtime集成，无法关联到App Insights的默认遥测流
2. GlobalProperties的全局影响：直接修改全局属性会影响所有后续遥测，且未绑定到当前Function的操作上下文
3. 未利用Function的操作上下文：Function触发时runtime会自动创建请求遥测上下文，之前的尝试未关联该上下文

解决方案 #

方案1：利用Function操作上下文（推荐） #

通过依赖注入获取已配置的TelemetryClient，关联Function runtime的操作上下文，直接给当前请求遥测添加属性：

public class FunctionHelper 
{
    private readonly IServiceProvider _serviceProvider;
    private readonly TelemetryClient _telemetryClient;

    // 注入Function runtime配置好的TelemetryClient，禁止自行创建
    public FunctionHelper(IServiceProvider serviceProvider, TelemetryClient telemetryClient)
    {
        _serviceProvider = serviceProvider;
        _telemetryClient = telemetryClient;
    }

    public IServiceScope BuildServiceScopeWithContext(string parameter1, string parameter2)
    {
        // 获取当前Function的请求遥测上下文
        var currentOperation = _telemetryClient.GetOperationHolder<RequestTelemetry>();
        if (currentOperation?.Telemetry is ISupportProperties supportProps)
        {
            // 仅当参数非空且属性不存在时添加
            if (!supportProps.Properties.ContainsKey("Parameter1") && parameter1 != null)
            {
                supportProps.Properties["Parameter1"] = parameter1;
            }
            if (!supportProps.Properties.ContainsKey("Parameter2") && parameter2 != null)
            {
                supportProps.Properties["Parameter2"] = parameter2;
            }
        }

        // 执行Helper逻辑并返回Scope
        var scope = _serviceProvider.CreateScope();
        // ... 其余业务逻辑
        return scope;
    }
}

方案2：AsyncLocal上下文 + 自定义TelemetryInitializer #

通过AsyncLocal存储参数，结合自定义Initializer将参数附加到所有遥测：

1. 创建上下文存储类

public static class FunctionTelemetryContext
{
    private static readonly AsyncLocal<(string? Param1, string? Param2)> _parameters = new();

    public static void SetParameters(string? param1, string? param2)
    {
        _parameters.Value = (param1, param2);
    }

    public static (string? Param1, string? Param2) GetParameters()
    {
        return _parameters.Value;
    }

    public static void Clear()
    {
        _parameters.Value = (null, null);
    }
}

2. 自定义TelemetryInitializer

public class FunctionTelemetryInitializer : ITelemetryInitializer
{
    public void Initialize(ITelemetry telemetry)
    {
        if (telemetry is not ISupportProperties supportProps)
            return;

        var (param1, param2) = FunctionTelemetryContext.GetParameters();

        if (param1 != null && !supportProps.Properties.ContainsKey("Parameter1"))
        {
            supportProps.Properties["Parameter1"] = param1;
        }
        if (param2 != null && !supportProps.Properties.ContainsKey("Parameter2"))
        {
            supportProps.Properties["Parameter2"] = param2;
        }
    }
}

3. Helper方法中设置上下文

public class FunctionHelper 
{
    private readonly IServiceProvider _serviceProvider;

    public FunctionHelper(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }

    public IServiceScope BuildServiceScopeWithContext(string parameter1, string parameter2)
    {
        FunctionTelemetryContext.SetParameters(parameter1, parameter2);
        try
        {
            var scope = _serviceProvider.CreateScope();
            // ... 其余业务逻辑
            return scope;
        }
        finally
        {
            // 必须清除上下文，避免泄漏到其他Function调用
            FunctionTelemetryContext.Clear();
        }
    }
}

4. 在Startup中注册Initializer

[assembly: FunctionsStartup(typeof(YourNamespace.Startup))]
namespace YourNamespace
{
    public class Startup : FunctionsStartup
    {
        public override void Configure(IFunctionsHostBuilder builder)
        {
            builder.Services.AddSingleton<ITelemetryInitializer, FunctionTelemetryInitializer>();
        }
    }
}

关键注意事项 #

• 禁止自行创建TelemetryConfiguration：必须通过依赖注入获取TelemetryClient，确保与Function runtime的App Insights配置一致
• 上下文清理：使用AsyncLocal时必须在finally块中清除上下文，避免跨请求泄漏
• 属性幂等性：添加属性前检查是否已存在，避免重复写入

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