在核心启动期间使用 Serilog 和 Sentry ASP.NET

Question

我正在尝试将应用程序启动期间抛出的错误记录给哨兵。我正在使用 ASP.NET Core 2.1.2，带有Serilog和Sentry。如果我只使用哨兵，它似乎工作正常。

WebHost.CreateDefaultBuilder(args)
.UseSentry("dsn")
.UseStartup<Startup>()
.Build()
.Run();

但是，如果我添加 Serilog，该应用程序在启动期间不会发送任何事件，尽管如果控制器操作引发异常，它会继续工作。

WebHost.CreateDefaultBuilder(args)
.UseSerilog(
(hostingContext, loggerConfiguration) =>
loggerConfiguration
.Enrich.FromLogContext()
.MinimumLevel.Debug()
.WriteTo.Console()
.WriteTo.Sentry(s => {
s.MinimumBreadcrumbLevel = LogEventLevel.Debug;
s.MinimumEventLevel = LogEventLevel.Error;
}))
.UseSentry("dsn")
.UseStartup<Startup>()
.Build()
.Run();

我正在尝试从 Startup 类中的ConfigureServices和Configure方法进行记录：

public class Startup
{
public Startup(IConfiguration configuration, ILogger<Startup> logger)
{
Configuration = configuration;
Logger = logger;
}
public IConfiguration Configuration { get; }
public ILogger<Startup> Logger { get; }
public void ConfigureServices(IServiceCollection services)
{
Logger.LogError(new Exception("something went wrong while configuring services"), "ERROR");
services
.AddMvc()
.AddJsonOptions(options =>
{
options.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";
})
.SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
Logger.LogError(new Exception("something went wrong while configuring app"), "ERROR");
}
}

我想这与每个记录器的初始化顺序有关，但我对启动过程的理解不足以提出解决方案或至少解释。知道为什么会发生这种情况以及如何解决它吗？

更新

似乎将 DNS 显式添加到 serilog 配置也可以解决此问题，尽管这似乎与哨兵存储库中的示例相反。

.UseSerilog(
(hostingContext, loggerConfiguration) =>
loggerConfiguration
.Enrich.FromLogContext()
.MinimumLevel.Debug()
.WriteTo.Console()
.WriteTo.Sentry(s => {
s.MinimumBreadcrumbLevel = LogEventLevel.Debug;
s.MinimumEventLevel = LogEventLevel.Error;
s.Dsn = new Dsn(dsn);
}))

Answer 1

ASP.NET Core 日志记录基础结构在应用程序请求管道之前构建。因此，我们只能通过日志记录集成捕获应用启动期间发生的异常。

仅使用Sentry.AspNetCore时捕获应用程序初始化错误的原因是此包依赖于Sentry.Extensions.Logging。

当你执行UseSentry时，它会在内部挂钩到框架日志记录基础结构中。Startup类中的崩溃发生在实际生成应用之前(需要完成ConfigureServices和Configure才能启动应用)，因此只有使用 Logging 集成，我们才能在此时捕获错误。

将Serilog添加到应用后，默认日志记录后端将被它替换。这意味着，Sentry.Extensions.Logging完成的对日志记录基础结构的钩子不再生效，因为Serilog已经接管了。

因此，您还需要添加包Sentry.Serilog。 在这种情况下，添加两个包后，仅当您通过Serilog集成初始化 SDK 时，您才能捕获引导错误(就像您在上一条评论中所做的那样)。为了避免混淆，样本中没有这样做(为什么我需要提供两次DSN？)，但是在后台发生的事情是，Serilog完成的第一次初始化只有在Startup过程完成之前才真正有用。初始化Sentry.AspNetCore后，它将关闭Serilog集成创建的第一个客户端，并刷新所有事件并将新客户端添加到主范围。这可确保请求数据等内容也添加到事件中。