Voyager.Enricher.Identity 1.0.1

Voyager.Enricher.Identity

Voyager.Enricher.Identity is a library that provides an enricher for Identity data. The credentials are passed by a function, allowing them to be supplied by Dependency Injection (DI).

Features

• Enriches Serilog logs with Identity data.
• Credentials are supplied via a function, enabling DI.

Installation

To install Voyager.Enricher.Identity, run the following command:

dotnet add package Voyager.Enricher.Identity 

Usage

To use the Identity enricher in your Serilog configuration, call the WithIdentityEnricher extension method:

using Serilog;
using Serilog.Configuration;
using Voyager.Enricher.Identity;

var logger = new LoggerConfiguration()
    .Enrich.WithIdentityEnricher(() => new MyIdentityProvider())
    .CreateLogger();

Implementing IdentityProvider

Here is an example of how to implement the IdentityProvider:

using Microsoft.AspNetCore.Http;
using Voyager.Enricher.Identity;

public class PilotRozIdentityProvider : IdentityProvider
{
    private readonly IHttpContextAccessor httpContextAccessor;
    private readonly IIdentityProvider identityProvider;

    public PilotRozIdentityProvider(IHttpContextAccessor httpContextAccessor, IIdentityProvider identityProvider)
    {
        this.httpContextAccessor = httpContextAccessor;
        this.identityProvider = identityProvider;
    }

    public Identity GetIdentity()
    {
        var identityS3 = identityProvider!.Build(httpContextAccessor!.HttpContext!.User);
        return new Identity(identityS3.BusId, identityS3.Login, identityS3.IdAkwizytor);
    }
}

Registering Serilog with the Enricher

Here is an example of how to register Serilog with the Identity enricher in your application:

.ConfigureLogging((hostingContext, loggingBuilder) =>
{
    loggingBuilder.ClearProviders();
    loggingBuilder.Services.AddTransient<Voyager.Enricher.Identity.IdentityProvider, PilotRozIdentityProvider>();
    loggingBuilder.Services.AddSerilog((sp, lg) =>
    {
        lg.ReadFrom.Configuration(hostingContext.Configuration);
        lg.Enrich.WithIdentityEnricher(() =>
        {
            return sp.GetService<Voyager.Enricher.Identity.IdentityProvider>()!;
        });
    });

#if DEBUG
    var file = File.CreateText("Self.log");
    SelfLog.Enable(TextWriter.Synchronized(file));
#endif
})

Building the Project

To build the project, run the following command:

dotnet build

Running Tests

To run the tests, use the following command:

dotnet test

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Authors

• Andrzej Świstowski

Project URL

For more information, visit the project page.

Repository URL

The repository is hosted on GitHub at Voyager.Enricher.Identity.