ErrorDock.Extensions.Logging 0.1.0-rc.1

ErrorDock.Extensions.Logging

ErrorDock for applications built on the .NET generic host — worker services, console applications, Windows Services. Adds AddErrorDock() and an ILogger provider, and sends to ErrorDock.

dotnet add package ErrorDock.Extensions.Logging

Building an ASP.NET Core application? Install ErrorDock.AspNetCore instead — it depends on this package and adds the request middleware. Building something with no host at all? ErrorDock.Core has a static entry point for that.

Getting started

using ErrorDock;

var builder = Host.CreateApplicationBuilder(args);

builder.Services.AddErrorDock(options =>
{
    options.ApiKey = "ed_live_…";
    options.Endpoint = "https://api.errordock.com";
    options.Release = typeof(Program).Assembly.GetName().Version?.ToString();
});

// Opt-in, and Warning and above by default. A service that shipped its Information logs
// would spend a monthly quota in an afternoon.
builder.Logging.AddErrorDock();

var host = builder.Build();

await host.RunAsync();

Environment defaults to the host environment name, so it is usually one line less than it looks. Configuration can come from appsettings.json instead, under the ErrorDock section:

{
  "ErrorDock": {
    "ApiKey": "ed_live_…",
    "Endpoint": "https://api.errordock.com",
    "MinimumLogLevel": "Warning"
  }
}

Use a server key (ed_live_) for anything that runs on hardware you control. For an application you ship to somebody else's machine, use an application key (ed_app_) — a secret inside an installer is a secret your customers hold.

Reporting

Inject IErrorDockClient wherever you need it:

public sealed class NightlyExport(IErrorDockClient errorDock)
{
    public async Task RunAsync(CancellationToken cancellationToken)
    {
        await errorDock.RunFeatureAsync("nightly-export", () => _exporter.RunAsync(cancellationToken));
    }
}

RunFeatureAsync records the execution, marks it failed if the task faults, and rethrows. Use it, not RunFeature, for anything that returns a Task: the synchronous overload would record the moment the task was created — a duration of nothing and an outcome of Ok whatever happened afterwards. That produces the denominator as well as the numerator, which is what makes a feature error rate a number rather than a guess.

Shutdown

The host stops the SDK for you: the background dispatcher flushes once more when the application is shutting down, and whatever it cannot deliver is written to the offline queue for the next start. A worker restarted mid-deploy no longer loses the events that were in flight.

What it guarantees

Everything ErrorDock.Core guarantees — it never throws, never blocks, gives up on purpose, and follows the dashboard. This package adds the host wiring and takes abstractions only (Microsoft.Extensions.*.Abstractions plus Microsoft.Extensions.Http), so it never decides which version of the host you run.

Licence

MIT. The ErrorDock service itself is proprietary; this SDK is not.