如何从Serilog中排除特定的异常类型？

Question

我正在使用Serilog记录有关IIS上托管的asp.net core 2.1应用程序的信息。当发生异常时，我会通过电子邮件通知我。问题是，一些异常发生而不会伤害应用程序，我不希望每次发生时都会被注意到。

Serilog中是否有一种方法可以排除特定的异常类型？

编辑：

以下是我在Program.cs中配置Serilog的方法：

using System;
using System.Data;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Serilog;
using Serilog.Sinks.MSSqlServer;

namespace WindZone_Warehouse_Mobile_App
{
    public class Program
    {
        public static void Main(string[] args)
        {
            var configuration = new ConfigurationBuilder()
                .AddJsonFile(Environment.CurrentDirectory + "/appsettings.json")
                .Build();

            var columnOptions = new ColumnOptions {
                AdditionalDataColumns = new System.Collections.ObjectModel.Collection<DataColumn>
                {
                    new DataColumn {DataType = typeof (string), ColumnName = "email", DefaultValue = "[email protected]", MaxLength = 4000},
                    new DataColumn {DataType = typeof (string), ColumnName = "subject", DefaultValue = "Application error", MaxLength = 4000},
                }
            };
            columnOptions.Store.Remove(StandardColumn.Level);
            columnOptions.Store.Remove(StandardColumn.LogEvent);
            columnOptions.Store.Remove(StandardColumn.Message);
            columnOptions.Store.Remove(StandardColumn.MessageTemplate);
            columnOptions.Store.Remove(StandardColumn.Properties);
            columnOptions.Store.Remove(StandardColumn.TimeStamp);
            columnOptions.Exception.ColumnName = "message";
            columnOptions.Id.ColumnName = "id";
            columnOptions.DisableTriggers = true;

            Log.Logger = new LoggerConfiguration()
                .MinimumLevel.Debug()
                .MinimumLevel.Override("Microsoft", Serilog.Events.LogEventLevel.Information)
                .Enrich.FromLogContext()
                .Filter.ByExcluding(ObjectDisposedException) //What is the right way to tell Serilog to ignore this type of exception?
                .WriteTo.RollingFile("logs\\log-{Hour}.txt", retainedFileCountLimit: 168)
                .WriteTo.MSSqlServer(
                connectionString: configuration.GetConnectionString("DefaultConnection"),
                tableName: "emailtosend",
                columnOptions: columnOptions,
                restrictedToMinimumLevel: Serilog.Events.LogEventLevel.Error
                )
                .CreateLogger();

            CreateWebHostBuilder(args).Build().Run();
        }

        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .UseStartup<Startup>()
                .UseSerilog();
    }
}

编辑2：

@reza baiat，@ GoldAge和@Alessandro Di Cicco：当然，你的答案将允许我处理异常，但只是在Serilog记录器之外发生的异常。 Serilog是一个日志库，取代了Microsoft的默认库，可以省略其余代码中的所有Try / Catch，因为它会将它们全部记录在（在我的例子中）日志文件和SQL表中。我要做的就是告诉Serilog不要记录，例如，在关键代码中发生的ObjectDisposedException异常。我想Try / Catch在我的代码中令人困惑，所以我会从我的例子中删除它，因为它不相关。一旦构建并运行应用程序，Serilog将捕获抛出的任何异常。我想的可能是另外一个像这样的Serilog配置行：.Filter.ByExcluding(ObjectDisposedException)或类似的东西。可能吗？

谢谢

Answer 1

Serilog中是否有一种方法可以排除特定的异常类型？

我只是为这种特定类型的异常创建一个空的catch，并且在body内部不执行任何操作，例如

try
{
    // invoke some function/s
}
catch (BlahException)
{
    // do nothing
}
catch (Exception e)
{
    Log.Fatal(ex, "Host terminated unexpectedly");
    // do something
}
finally
{
    Log.CloseAndFlush();
}

如果你想忽略更多异常，我会创建一些额外的函数来检查你是否要记录这种类型的错误。

// list of error codes:
// https://docs.microsoft.com/en-gb/windows/desktop/Debug/system-error-codes
public static bool IgnoreError(int errorCode)
{
    switch (errorCode)
    {
        case 16389:
            return true;
        case 16387:
            return true;
        default:
            return false;
    }
}

然后在catch块中，您可以将异常代码传递给此方法。例如

try
{
    throw new ArgumentNullException("value");
}
catch (Exception e) 
{
    // Using an AND operation will retrieve the error code from the HRESULT:
    if (IgnoreError(e.HResult & 0xFFFF))
    {
        return;
    }
    Log.Fatal(e, "message");
}

我认为记录器应该记录每个未处理的异常，因为这是它的主要责任。我没有看到任何优势忽略记录未处理的异常，并且不应该有这样的设置，这太可怕了！如果您知道在给定位置可能发生异常，那么您应该创建try和catch块以捕获尽可能多的预期异常。然后，如果要忽略catch块中的某些特定异常或no，则可以做出决定。

Answer 2

下面的代码可以帮到你

catch (Exception ex)
{
    if (ex.GetType() != typeof(ExceptionTypeToExclude) ) {
         Log.Fatal(ex, "Host terminated unexpectedly");
    }
    return;
}

Answer 3

您可以使用填充了要排除的所有异常类型的HashSet<TypeInfo>，然后检查当前的异常是否包含在其中：

HashSet<TypeInfo> ignore = new HashSet<TypeInfo>();
ignore.Add(typeof(SomeExceptionType).GetTypeInfo());

//Add all the exceptions you want to exclude

您现在可以像这样测试您的Exception类型：

try {
   //Critical code
}
catch (Exception e) {
    if (!ignore.Contains(e.GetType().GetTypeInfo())) //Do stuff
}

您需要添加using System.Reflection才能使用TypeInfo类型