How to set up Serilog.Exceptions for Entity Framework Core?

Install the Serilog.Exceptions.EntityFrameworkCore NuGet package and add the DbUpdateExceptionDestructurer during configuration to avoid logging sensitive data like entire database schemas. Always follow the warning in the README to prevent data exposure.

Does Serilog.Exceptions slow down logging performance?

It's optimized with custom destructurers for common exceptions to minimize reflection overhead. Reflection is used only for unsupported types, and expensive operations are done once per exception-type, so impact is minimal in most cases.

How to add a custom exception destructurer in Serilog.Exceptions?

Create a class implementing IExceptionDestructurer, then add it during setup using WithDestructurers in the DestructuringOptionsBuilder. The README provides an example with ArgumentExceptionDestructurer for reference.

Serilog.Exceptions vs standard Exception.ToString() logging?

Serilog.Exceptions captures detailed properties not in ToString(), such as nested validation errors, which is essential for debugging complex exceptions. However, it requires proper sink configuration to output these properties, unlike default logging.

How to filter out StackTrace in Serilog.Exceptions logs?

Use the WithIgnoreStackTraceAndTargetSiteExceptionFilter or implement a custom IExceptionPropertyFilter during configuration with DestructuringOptionsBuilder to skip redundant properties and reduce log clutter.

Can Serilog.Exceptions work with console sink?

Yes, but you must adjust the output template to include {Properties:j} to display enriched exception details, as mentioned in the getting started section. Otherwise, the console sink won't show the extra data.

Serilog.Exceptions — Serilog Exception Details Enricher

What is Serilog.Exceptions?

Serilog.Exceptions is a Serilog enricher library for .NET that captures and logs detailed exception information and custom properties not included in the standard `Exception.ToString()` output. It solves the problem of missing critical debugging data in structured logs, such as nested validation errors in Entity Framework exceptions. By providing deep destructuring of exceptions, it ensures developers have complete visibility into failures.

Target Audience

.NET developers using Serilog for structured logging who need comprehensive exception details for debugging complex applications, particularly those working with databases, web APIs, or microservices.

Value Proposition

Developers choose Serilog.Exceptions because it fills a critical gap in Serilog's default logging by extracting hidden exception properties essential for debugging, does so with minimal performance impact using optimized destructurers, and offers extensibility for custom and third-party exceptions through a modular package ecosystem.

Log exception details and custom properties that are not output in Exception.ToString().

Use Cases

Best For

Logging Entity Framework validation errors with full detail
Capturing custom properties from domain-specific exceptions
Enhancing structured logs for microservices debugging
Avoiding reflection overhead for common SQL and gRPC exceptions
Filtering out redundant or sensitive exception properties
Integrating detailed exception logging with JSON-based log sinks

Not Ideal For

Projects not using Serilog as their logging framework
Applications with stringent log storage constraints where detailed exception data could excessively increase volume
Teams unwilling to manage additional NuGet dependencies for library-specific destructurers (e.g., Entity Framework Core, SQL Server)

Pros & Cons

Pros

Deep Exception Destructuring

Logs nested custom properties from exceptions like DbEntityValidationException that are missing from standard ToString(), as shown in the README's JSON example with EntityValidationErrors.

Performance Optimized

Uses custom destructurers for common exception types to minimize reflection overhead, falling back only for unsupported types, with reflection operations cached per exception-type.

Extensible Architecture

Supports custom destructurers for user-defined exceptions and offers additional NuGet packages for libraries like Entity Framework Core, SQL Server, and gRPC to avoid reflection.

Configurable Filtering

Allows filtering of properties like StackTrace and TargetSite to avoid duplication or sensitive data logging, using built-in or custom IExceptionPropertyFilter implementations.

Cons

Risk of Data Exposure

The README warns that without proper configuration, Entity Framework exceptions can log entire database schemas (e.g., via IQueryable properties), posing a security risk that requires additional destructurers to mitigate.

Dependency Management Overhead

Optimal performance requires installing separate NuGet packages for specific exception types (e.g., Serilog.Exceptions.EntityFrameworkCore), adding to project complexity and maintenance.

Configuration Complexity

Setting up sinks to output enriched properties (e.g., adding {Properties:j} to templates) and configuring destructurers involves extra steps beyond basic Serilog setup, which can be error-prone.

Frequently Asked Questions

What is Serilog.Exceptions?

Target Audience

Value Proposition

Use Cases

Best For

Logging Entity Framework validation errors with full detail
Capturing custom properties from domain-specific exceptions
Enhancing structured logs for microservices debugging
Avoiding reflection overhead for common SQL and gRPC exceptions
Filtering out redundant or sensitive exception properties
Integrating detailed exception logging with JSON-based log sinks

Not Ideal For

Projects not using Serilog as their logging framework
Applications with stringent log storage constraints where detailed exception data could excessively increase volume
Teams unwilling to manage additional NuGet dependencies for library-specific destructurers (e.g., Entity Framework Core, SQL Server)

Pros & Cons

Pros

Deep Exception Destructuring

Logs nested custom properties from exceptions like DbEntityValidationException that are missing from standard ToString(), as shown in the README's JSON example with EntityValidationErrors.

Performance Optimized

Uses custom destructurers for common exception types to minimize reflection overhead, falling back only for unsupported types, with reflection operations cached per exception-type.

Extensible Architecture

Supports custom destructurers for user-defined exceptions and offers additional NuGet packages for libraries like Entity Framework Core, SQL Server, and gRPC to avoid reflection.

Configurable Filtering

Allows filtering of properties like StackTrace and TargetSite to avoid duplication or sensitive data logging, using built-in or custom IExceptionPropertyFilter implementations.

Cons

Risk of Data Exposure

Dependency Management Overhead

Optimal performance requires installing separate NuGet packages for specific exception types (e.g., Serilog.Exceptions.EntityFrameworkCore), adding to project complexity and maintenance.

Configuration Complexity

Setting up sinks to output enriched properties (e.g., adding {Properties:j} to templates) and configuring destructurers involves extra steps beyond basic Serilog setup, which can be error-prone.

Frequently Asked Questions

Serilog.Exceptions

What is Serilog.Exceptions?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Serilog.Exceptions

What is Serilog.Exceptions?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?