SunAuto.Logging 1.0.0

SunAuto.Logging

A standard Microsoft.Extensions.Logging provider for Sun Auto applications. Supports console output, a custom sink delegate, and built-in forwarding to a Splunk HTTP Event Collector (HEC).

Target Frameworks

net8.0 · net9.0 · net10.0 · netstandard2.1

Installation

dotnet add package SunAuto.Logging

Usage

Generic Host / ASP.NET Core

var builder = WebApplication.CreateBuilder(args);

builder.Logging.ClearProviders();
builder.Logging.AddSunAutoLogging(options =>
{
    options.MinimumLevel    = LogLevel.Information;
    options.IncludeScopes   = true;
    options.IncludeTimestamp = true;
});

Configuration via appsettings.json

{
  "Logging": {
    "SunAuto": {
      "MinimumLevel": "Information",
      "IncludeScopes": true,
      "IncludeTimestamp": true,
      "TimestampFormat": "yyyy-MM-ddTHH:mm:ss.fffZ"
    }
  }
}

Then register without a configuration delegate:

builder.Logging.AddSunAutoLogging();

Custom Sink

Route log output to any destination by supplying a Sink delegate:

builder.Logging.AddSunAutoLogging(options =>
{
    options.Sink = line => MyExternalSystem.Write(line);
});

When Sink is null (the default) and no Splunk options are configured, output goes to Console.Out.

Splunk HEC

Set all three Splunk options to enable automatic forwarding to a Splunk HTTP Event Collector. Log entries are batched and posted asynchronously.

builder.Logging.AddSunAutoLogging(options =>
{
    options.Splunk = new()
    {
        BaseUrl = "https://splunk-host:8088/",
        Token   = "<your-hec-token>",
        Source  = "my-api",
    };
});

Or via appsettings.json:

{
    "Logging": {
        "SunAuto": {
            "LogLevel": {
                "Default": "Information"
            },
            "Splunk": {
                "BaseUrl": "https://your-splunk-host:8088/",
                "Token": "your-hec-token",
                "Source": "my-app-sourcetype"
            }
        }
}

All three fields (Splunk.BaseUrl, Splunk.Token, Splunk.Source) must be present for the Splunk sink to activate. If a custom Sink delegate is also provided, it takes precedence and the Splunk sink is not created.

Options

Log Format

[2026-05-19T14:32:01.123Z] info MyApp.Services.RepairService: Order 1042 authorised. => Scope

Level labels: trce · dbug · info · warn · fail · crit

Contributing

Pull requests are welcome. For major changes, please open an issue first.

Run the unit tests before submitting:

dotnet test ../ClientTest/ClientTest.csproj

Please make sure to update tests as appropriate.

Support

If you like this project and think it has helped in any way, consider getting tires or auto service at a Sun Auto Tire & Service location near you:

<a href="https://sun.auto/home" target="_blank"><img src="https://sun.auto/wp-content/themes/sun-auto/images/logo_sunauto.png" alt="Sun Auto Tire & Service" width="150" height="65"/></a>