Serilog.Extras 1.0.6

Overview

This package contains two enrichers and a handler to add request logging but excluding health checks. The latter part is heavily based on Andrew Lock's blog entry.

Enrichers

Version Number

This takes the environment variable VERSION_NUMBER and, if presents, logs the value to a VersionNumber field. If not present, N/A is logged.

Usage

Add WithVersionNumber to the Enrich array in the Serilog configuration node.

Deployment Environment

This takes the environment variable ASPNETCORE_ENVIRONMENT and, if presents, logs the value to a DeploymentEnvironment field. If not present, N/A is logged.

Usage

Add WithDeploymentEnvironment to the Enrich array in the Serilog configuration node.

Request Logging Without Health Checks

This is the same as the standard app.UseSerilogRequestLogging() call but filters out health checks. This is heavily based on Andrew Lock's blog entry.

Usage

Use app.UseSerilogRequestLoggingWithoutHealthChecks() (instead of app.UseSerilogRequestLogging())

General Log Handler

The following is an example Program.cs and includes Swagger on the assumption this is for an API - simply remove if not required. It's assumed your logging is configured in a file called serilog.json.

using Serilog;
using Serilog.Extras;

AppDomain.CurrentDomain.UnhandledException += GeneralLogHandler.AppUnhandledException;

using (var logger = GeneralLogHandler.BuildSerilog())
{
    Log.Information("Application starting...");

    try
    {
        var builder = WebApplication.CreateBuilder(args);

        // load configuration
        builder.Configuration.AddEnvironmentVariables();

        // Add services to the container.
        // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
        builder.Services.AddEndpointsApiExplorer();
        builder.Services.AddSwaggerGen();

        builder.Host.UseSerilog();

        var app = builder.Build();

        // Configure the HTTP request pipeline.
        if (app.Environment.IsDevelopment())
        {
        }

        app.UseSwagger();
        app.UseSwaggerUI(c => { c.SwaggerEndpoint("../swagger/v1/swagger.json", "API v1.0"); });

        app.UseSerilogRequestLogging();

        app.MapEndpoints();

        app.Run();

    }
    catch (Exception e)
    {
        GeneralLogHandler.UnhandledExceptions(e);
    }
}