PackSite.Library.Logging.Abstractions 1.3.0

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore.

dotnet add package PackSite.Library.Logging.Abstractions --version 1.3.0

NuGet\Install-Package PackSite.Library.Logging.Abstractions -Version 1.3.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="PackSite.Library.Logging.Abstractions" Version="1.3.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add PackSite.Library.Logging.Abstractions --version 1.3.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: PackSite.Library.Logging.Abstractions, 1.3.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install PackSite.Library.Logging.Abstractions as a Cake Addin
#addin nuget:?package=PackSite.Library.Logging.Abstractions&version=1.3.0

// Install PackSite.Library.Logging.Abstractions as a Cake Tool
#tool nuget:?package=PackSite.Library.Logging.Abstractions&version=1.3.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Library.Logging

PackSite.Library.Logging is a set of .NET 5 and .NET 6 compatible libraries that speed up logging setup and Generic Host bootstrapping with Serilog and Microsoft.Extensions.Logging.

The libraries simplify and provide a generic solution to the problem described in an article Bootstrap logging with Serilog + ASP.NET Core.

(...) Errors during application start-up are some of the nastiest problems to hit in production. Deployment issues like broken manifests or missing assemblies, incorrect settings, exceptions thrown during IoC container configuration or in the constructors of important components - these can bring start-up to a screeching halt and cause a process exit, without leaving even so much as an error page. (...)

~ nblumhardt (Oct 12, 2020)

Features

Host bootstrapping that provides application logs during host build, especially when app configuration or Serilog configuration are broken.
Follows a principal of "always logging something even if host build, logging configuration, or host startup fails critically".
Simplifies integration tests by providing a simple interface for setting host/program options.
Simplifies Program.cs by eliminating the need of writing complex logger configurations and try-catch-finally blocks.
Simplifies Serilog configuration by providing a set of recent enrichers and sinks.
Supports Serilog and Microsoft.Extensions.Logging based bootstrapping.
Supports Entity Framework Migrations generation by bypassing the bootstrapper.

Examples

See Examples folder for all library usage examples.

Quick start

using PackSite.Library.Logging;
using PackSite.Library.Logging.Serilog;

public class Program
{
    public static async Task Main()
    {
        await CreateBootstrapper()
            .RunAsync();
    }

    public static IBootstrapperManager CreateBootstrapper(
        Action<IConfigureBootstrapperOptions>? options = null)
    {
        return BootstrapperManagerBuilder.Create<SerilogBootstrapper>()
            .CreateHostBuilder(CreateHostBuilderWithBootstraper)
            .ConfigureOptions(options ?? (o => { }))
            .Build();
    }

    [SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", 
                     Justification = "Used for generating EF Core migrations - bypassed bootstrapper.")]
    private static IHostBuilder CreateHostBuilder(string[] args)
    {
        return CreateHostBuilderWithBootstraper(new BootstrapperOptions(args));
    }

    private static IHostBuilder CreateHostBuilderWithBootstraper(
        BootstrapperOptions bootstraperOptions)
    {
        return Host.CreateDefaultBuilder(bootstraperOptions.Args)
            .UseEnvironment(bootstraperOptions.EnvironmentName)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            })
            .UseSerilog((context, services, loggerConfiguration) =>
            {
                loggerConfiguration.ConfigureWithFailSafeDefaults(context.Configuration);
            }, preserveStaticLogger: false, writeToProviders: false);
    }
}

Product	Compatible and additional computed target framework versions.
.NET	net5.0 is compatible. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net5.0
- Microsoft.Extensions.Configuration (>= 5.0.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 5.0.0)
- Microsoft.Extensions.Configuration.Json (>= 5.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 5.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 5.0.0)
net6.0
- Microsoft.Extensions.Configuration (>= 6.0.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 6.0.0)
- Microsoft.Extensions.Configuration.Json (>= 6.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 6.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.0)

NuGet packages (2)

Showing the top 2 NuGet packages that depend on PackSite.Library.Logging.Abstractions:

Package	Downloads
PackSite.Library.Logging.Serilog Serilog based logging and bootstrapping	10.6K
PackSite.Library.Logging.Microsoft Microsoft.Extensions.Logging based logging and bootstrapping	8.1K