UKHO.Logging.Serilog 2.26036.3

UKHO.Logging.Serilog

This UKHO.Logging.Serilog package targets .NET 8 and provides some UKHO specific Enricher classes for use with with Serilog to ensure that ASP .Net Core Web API projects within UKHO are logging details in a consistent manner.

• This repository overview
• Installation Guide
• Setting up your project to use Serilog
• Enrichers Details

Usage

    builder.services.AddUkhoLoggingConfiguration();
    builder.services.AddUkhoLogging();

or

    builder.services.AddUkhoLogging(config => 
    {
        config.Environment = "Development";
        config.ProjectName = "Global Kittens";
        config.ServiceName = "Global Kitten Registration API";
    });

Configuration

The package can read configuration from 'appsettings.json' (or whatever source(s) your IConfiguration is configured to use):

{
  "UkhoLogging": {
    "Environment": "Development",
    "ProjectName": "Global Kittens",
    "ServiceName": "GLobal Kitten Registration API"
  }
}

The section name "UkhoLogging" is required, as are the four properties:

Environment

The name of the runtime environment, one of "Development", "Testing", or "Production".

ProjectName

The name of the overarching project.

ServiceName

The name of the specific service.

EventHubConnectionString

The connection string for the Event Hub to which log events will be sent. This contains a secret, so it must not be checked into source control. However, since the property is tagged as 'Required', you will need to provide a dummy value in your appsettings.json file and then override it with your runtime source of IConfiguration.

Effect

The package pulls in and configures Serilog and adds a number of enrichers to the logging pipeline that add UKHO required properties to log events:

• correlation-id
• environment
• exception
• level
• message-rendered
• project.name
• properties
• service.name
• timestamp
• trace.id
• transaction.id
• ukho.assembly.informational-version
• ukho.assembly.name
• ukho.assembly.version
• ukho.logging.version
• ukho.no-http-context
• ukho.no-http-context-accessor
• ukho.remote.ipaddress
• ukho.request.host
• ukho.request.method
• ukho.request.path
• ukho.request.querystring
• ukho.request.scheme
• ukho.request.user-agent

It also pulls in the Serilog Azure Event Hub sink and configures it using the EventHubConnectionString config property. This will ship your log events to the Event Hub, formatted using the Elastic Common Schema (ECS) so that they can be ingested by the UKHO ElasticCloud instance.

The UK Hydrographic Office (UKHO) supplies hydrographic information to protect lives at sea. Maintaining the confidentiality, integrity and availability of our services is paramount. Found a security bug? Please report it to us at UKHO-ITSO@gov.co.uk