ApplicationInsights - 如何跟踪 WebAPI 使用情况

Question

我已经使用 ApplicationInsights 几个月了。 虽然它对于一般的 MVC 和 Web 应用程序非常有用，但我有一些 WebAPI 服务应用程序我想跟踪它们的使用情况。

例如，我的应用程序中有不同的 RESTful API，我想查看每天（或一段时间内）进行多少调用以比较使用情况。

ApplicationInsights 中的用法选项卡似乎是为 HTML Web 应用程序量身定制的。

有没有办法将它用于服务？

Answer 1

如果我没有正确回答您的问题，您希望根据用户确定每个 API 的使用情况。您已经为每个 API 提供了可用的请求数据，但由于我们不会跟踪每个遥测事件的用户，因此无法根据用户对其进行过滤。

如果您想根据用户或任何属性过滤遥测数据（请求、异常等），您需要它在遥测事件的属性中可用，以便您可以直接过滤它并在指标浏览器。为此，您可以创建一个TelemetryInitializer。

遥测初始化器允许您添加全局属性以及所有遥测数据，这意味着它将针对从您的应用发送的所有遥测事件执行。这是一个跟踪 UserID 以及每个遥测事件的示例。我假设 User.Identity 将为您设置，因为您使用的是 Windows 身份验证。只要在 Http 请求中设置了 IPrinicipal，这也适用于任何其他身份验证（Azure AD、基于证书的身份验证等）。

public class UserTelemetryIntitializer : ITelemetryInitializer
{
    public void Initialize(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry)
    {
        var context = HttpContext.Current;

        if (context == null)
            return;

        // If user has authenticated, add a property UserID to telemetry which will have
        //  * domain\\username for Windows Authentication
        //  * username@domain.com for Azure AD Authentication
        if (context.User.Identity.IsAuthenticated)
            telemetry.Context.Properties["UserID"] = context.User.Identity.Name;
        else
            telemetry.Context.Properties["UserID"] = "Null";
    }
}

不要忘记使用 ApplicationInsights.config 加载遥测初始化程序：

<ApplicationInsights>
  <TelemetryInitializers>
    <!-- Fully qualified type name, assembly name: -->
    <Add Type="MvcWebApp.Telemetry.UserTelemetryIntitializer, MvcWebApp"/>
    ...
  </TelemetryInitializers>
</ApplicationInsights>

或者，您也可以使用代码加载初始化程序。在你的global.asax.cs 或WebApiConfig.cs：

protected void Application_Start()
{
    TelemetryConfiguration.Active.TelemetryInitializers
        .Add(new UserTelemetryIntitializer());
}

您可以阅读有关 Telemetry Initializers here 的更多信息。