将 Application Insights 与 ILoggerFactory 结合使用

Question

我正在尝试将异常记录到 Application Insights。我通过直接调用TelemetryClient.TrackException 成功地做到了这一点。但是，我想在我的代码中对此进行抽象，以防将来我想登录到其他平台，所以我想只坚持 ILogger 接口。

我发现您可以使用ILoggerFactory.AddApplicationInsights（已实现here），但无论我做什么，我都看不到ApplicationInsights 中显示的日志。

下面是我的代码：

Startup.cs

    IConfigurationRoot Configuration { get; set; }
    ILoggerFactory LoggerFactory { get; set; }
    IServiceProvider ServiceProvider { get; set; }

    public Startup( IHostingEnvironment hostingEnvironment, ILoggerFactory loggerFactory )
    {
        this.LoggerFactory = loggerFactory;
        string configurationFilePath = "abc.json";

        this.Configuration = new ConfigurationBuilder()
            .SetBasePath( hostingEnvironment.ContentRootPath )
            .AddJsonFile( configurationFilePath, optional: true, reloadOnChange: true )
            .AddEnvironmentVariables()
            .Build();
    }

    public void Configure(
        IApplicationBuilder applicationBuilder,
        IHostingEnvironment hostingEnvironment,
        ILoggerFactory loggerFactory,
        IServiceProvider serviceProvider )
    {
        this.ServiceProvider = serviceProvider;
        loggerFactory.AddApplicationInsights( serviceProvider );
        applicationBuilder.UseMvc();
    }

    public void ConfigureServices( IServiceCollection services )
    {
        services.AddApplicationInsightsTelemetry( this.Configuration );
        services.AddMvc( .... // A bunch of options here ... )
    }

然后，我尝试像这样在我的控制器中使用它：

    ILogger<XController> Logger { get; set; }

    public XController( ILogger<XController> logger )
    {
        this.Logger = logger;
    }

    [HttpPost]
    [Route( "v3.0/abcd" )]
    public async Task PostEvent( [FromBody] XEvent xEvent )
    {
        this.Logger.LogError( 0, new Exception( "1234" ), "1234" );
    }

但是，我根本没有看到与该请求相关的任何异常。如果我用TelemetryClient.TrackException 替换Logger.LogError 行（并首先创建TelemetryClient），那么我可以毫无问题地看到异常。

我不知道我做错了什么。有人可以帮忙吗？

Answer 1

根据您的描述，我建议您可以尝试以下代码来启用 ILogger 将错误记录到 ApplicationInsights。

您可以直接使用 loggerFactory.AddApplicationInsights() 方法来启用 ApplicationInsights ILogger。

更多细节，您可以参考以下代码：

启动类：

public class Startup
{
    public Startup(IHostingEnvironment env)
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(env.ContentRootPath)
            .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
            .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
            .AddEnvironmentVariables();
        Configuration = builder.Build();
    }

    public IConfigurationRoot Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddApplicationInsightsTelemetry(Configuration);
        // Add framework services.
        services.AddMvc();
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {

        loggerFactory.AddApplicationInsights(app.ApplicationServices,LogLevel.Warning);

        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
            app.UseBrowserLink();
        }
        else
        {
            app.UseExceptionHandler("/Home/Error");
        }

        app.UseStaticFiles();

        app.UseMvc(routes =>
        {
            routes.MapRoute(
                name: "default",
                template: "{controller=Home}/{action=Index}/{id?}");
        });
    }
}

appsettings.json：

{

  "ApplicationInsights": {
    "InstrumentationKey": "yourkey"
  }
}

结果：

---

更新：

在搜索功能中找到的记录。

Answer 2

现在使用Microsoft.Extensions.Logging.ApplicationInsights 提供程序对记录到 Application Insights 提供一流的支持。

Answer 3

我终于想通了。有两种方法可以解决我的问题：

简单的方法：

我使用的是旧版本的 Application Insights NuGet。具体来说， Microsoft.ApplicationInsights.2.2.0 和 Microsoft.ApplicationInsights.AspNetCore.2.0.0。

一旦我升级到 Microsoft.ApplicationInsights.2.4.0 和 Microsoft.ApplicationInsights.AspNetCore.2.1.1，一切正常。您还会看到 LogXXX 带有异常作为参数显示为 Exception，而没有异常的参数显示为 Trace。

稍微困难的方法：

由于某种原因，Configure 中的IApplicationBuilder 和IServiceProvider 没有提供正确的服务提供者在AddApplicationInsights 中使用，因此您需要在ConfigureServices 中添加提供者：

    public void ConfigureServices( IServiceCollection services )
    {
            IServiceProvider serviceProvider = services.BuildServiceProvider();
            this.LoggerFactory.AddApplicationInsights( serviceProvider, Extensions.Logging.LogLevel.Information );
            ...
    }

这意味着您需要将构造函数中的loggerFactory 保存到属性/字段中，因为它不能通过ConfigureServices 中的依赖注入获得。

我最终做了什么（在我看来可能是目前最好的解决方案）：

即使只执行上述任一解决方案都可以解决问题，但我还是决定同时执行。这是因为我也希望能够在ConfigureServices 中记录错误。如果我将loggerFactory.UseApplicationInsights 放入Configure，那么我将无法在ApplicationInsights 上看到ConfigureServices 中的错误。我也更喜欢同时查看 Traces 和 Exceptions，这是仅在新包版本中提供的功能。

Answer 4

不幸的是，SDK 仅在最近才更新为触发异常遥测（请参阅 commit），并且尚未发布更改。
我现在看到的唯一路线是在您的代码中保留对TelemetryClient.TrackException 的显式调用，或者用您自己的ILogger 实现将其全部包装——这两种方法都作为临时解决方案，直到官方SDK 支持这一点

Answer 5

这是带有 ILogger 的 App Insights 的 documentation。对我来说它有效，但是有大量的跟踪日志，所以建议你应用自定义过滤器：

builder.AddApplicationInsights("ikey");

builder.AddFilter<Microsoft.Extensions.Logging.ApplicationInsights.ApplicationInsightsLoggerProvider>
            ("", LogLevel.Information);
builder.AddFilter<Microsoft.Extensions.Logging.ApplicationInsights.ApplicationInsightsLoggerProvider>
            ("Microsoft", LogLevel.Warning);