azure-application-insights - Application Insights - 如何设置自定义操作 ID

Question

在我们当前的本地设置中，我们有 20 多个 .net core 3.1 API 应用程序(单独的 ASP.NET Core API 应用程序)。我们已开始将 2 个 APi 应用程序迁移到使用单个 Application Insights 实例标记的 Azure 应用程序服务。

在 On-Prem 中，我们使用其他 18 个应用程序的日志框架。所有这些 API 应用程序都相互通信，所有日志都与本地的一些 unique_id 相关联。

现在，对于 Azure 中的 API，我们需要利用相同的 unique_Id 并关联所有内容。

为了实现它，我开始探索为托管在 Azure 中的 2 个应用程序设置相同操作 ID 的功能。

在两个 API 中创建了 TelemetrInitializer。如果我在两个 API 中设置如下所示的 Operational Id，它就可以工作。所有日志都绑定(bind)到单个操作 ID“12345”

      telemetry.Context.Operation.Id = "12345";

但是，由于将操作 ID 设为动态是显而易见的，因此我在我的第一个 API 中将其更改为以下

  telemetry.Context.Operation.Id = "CR" + Guid.NewGuid().ToString();

因此，下一个挑战是，我需要将这个新的操作 ID 绑定(bind)到我的第二个 API 的 TelemetryInitiializer 中。为了实现这一点，我尝试在第二个 API 的 TelemetryInitializer 中获取 Request-Id header 。它始终为 NULL。

有什么办法可以实现吗？

谢谢，Praveen Sreeram.

Answer 1

tldr:这可以通过禁用 .NET Core 和 App Insights 中的内置依赖项跟踪并自行处理来实现。在大多数情况下，最好的做法是让 .NET Core 和 App Insights 进行跟踪。

我上传了一个简单的 WebAPI 应用程序，其中包含我要转到 Github 的代码:https://github.com/SamaraSoucy-MSFT/customoperationid

要获取 header 和 App Insights 以获取自定义操作 ID，需要覆盖两件事。第一个是将 HttpClient 包装为控制相关 header 的事件。第二个是 App Insights 中的依赖跟踪。

可以在您的 HttpClient 中使用 disable Actions completely，但为了最大限度地减少副作用，您可以通过设置 Activity.Current = null

删除客户端中的那个

var operationId = "CR" + Guid.NewGuid().ToString();
var url = "https://www.microsoft.com";
using (var client = new HttpClient())
{
    using (var requestMessage =
        new HttpRequestMessage(HttpMethod.Get, url))
    {
        //Makes the headers configurable
        Activity.Current = null;

        //set correlation header manually
        requestMessage.Headers.Add("Request-Id", operationId);
        await client.SendAsync(requestMessage);
    }
}

下一步是删除 App Insights 默认跟踪 for this request 。同样，您可以完全禁用依赖项跟踪，或者您可以为此请求使用 filter out the default telemetry。处理器就像初始化程序一样在 Startup 类中注册。

services.AddApplicationInsightsTelemetryProcessor<CustomFilter>();

public class CustomFilter : ITelemetryProcessor
{
    private ITelemetryProcessor Next { get; set; }

    // next will point to the next TelemetryProcessor in the chain.
    public CustomFilter(ITelemetryProcessor next)
    {
        this.Next = next;
    }

    public void Process(ITelemetry item)
    {
        // To filter out an item, return without calling the next processor.
        if (!OKtoSend(item)) { return; }

        this.Next.Process(item);
    }

    // Example: replace with your own criteria.
    private bool OKtoSend(ITelemetry item)
    {
        var dependency = item as DependencyTelemetry;

        if (dependency == null) return true;

        if (dependency.Type == "Http"
            && dependency.Data.Contains("microsoft.com")
            //This key is just there to help identify the custom tracking
            && !dependency.Context.GlobalProperties.ContainsKey("keep"))
        {
            return false;
        }
        return true;
    }
}

最后，在进行远程调用的方法中，需要注入(inject)遥测客户端并调用TelemetryClient.TrackDependency()

var operationId = "CR" + Guid.NewGuid().ToString();

//setup telemetry client
telemetry.Context.Operation.Id = operationId;
if (!telemetry.Context.GlobalProperties.ContainsKey("keep"))
{
    telemetry.Context.GlobalProperties.Add("keep", "true");
}
var startTime = DateTime.UtcNow;
var timer = System.Diagnostics.Stopwatch.StartNew();
//continue setting up context if needed

var url = "https:microsoft.com";
using (var client = new HttpClient())
{
    //Makes the headers configurable
    Activity.Current = null;

    using (var requestMessage =
        new HttpRequestMessage(HttpMethod.Get, url))
    {
        //Makes the headers configurable
        Activity.Current = null;

        //set header manually
        requestMessage.Headers.Add("Request-Id", operationId);
        await client.SendAsync(requestMessage);
    }
}

//send custom telemetry 
telemetry.TrackDependency("Http", url, "myCall", startTime, timer.Elapsed, true);