Pacem.Extensions.Logging.Http 0.10.12

HTTP Logging Extensions

⚗️ ==Experimental==

⚠️ Experimental libs are discouraged to use in production.

About

Pacem.Extensions.Logging.Http provides extensions to ship your logs to an HTTP endpoint (a webhook, a log-ingestion API, a collector, ...).

Delivery goes through IHttpClientFactory (a named client, pacem.logger.http) and is performed by a background consumer, one entry at a time, so logging calls never block on the network.

⚠️ The IHttpClientFactory pipeline logs its own requests under the System.Net.Http.* categories. Left unfiltered those entries feed straight back into this sink and amplify without bound — scope the sink to the categories you actually care about (builder.AddFilter(...) or the Filter option) or silence System.Net.Http.

The following paragraphs exemplify the library utilization given common use cases.

How to

Add the relevant logger provider to the logging builder (e.g. ILoggingBuilder). There are two ways to describe a delivery.

1. Converter mode — build the request, the sink sends it

Provide a HttpRequestLogPayload -> HttpRequestMessage converter. Use the configureClient overload to set the base address, headers or timeout of the named client.

// Program.cs
builder.Logging.AddPacemHttpLogging(
    // log line -> request
    log => new HttpRequestMessage(HttpMethod.Post, "/ingest")
    {
        Content = JsonContent.Create(new
        {
            timestamp = log.Timestamp,
            source = log.Name,
            level = log.LogLevel.ToString(),
            message = log.Message,
            error = log.Exception?.ToString(),
            data = log.Data
        })
    },
    client =>
    {
        client.BaseAddress = new Uri("https://logs.example.com");
        client.DefaultRequestHeaders.Add("X-Api-Key", "…");
    });

2. Executor mode — you own the send

Provide a (HttpClient, HttpRequestLogPayload) -> Task. Handy when you call an SDK, batch differently, or need the response.

builder.Logging.AddPacemHttpLogging(
    async (client, log) =>
    {
        using var response = await client.PostAsJsonAsync("/ingest", new
        {
            source = log.Name,
            level = log.LogLevel.ToString(),
            message = log.Message
        });
        response.EnsureSuccessStatusCode();
    },
    client => client.BaseAddress = new Uri("https://logs.example.com"));

A fourth overload takes a Func<IHttpClientFactory, HttpRequestLogPayload, HttpClient> instead of an Action<HttpClient>, when you want to pick or build the client per entry.

ℹ️ If neither a converter nor an executor is configured the provider throws on the first write.

Options

Every overload accepts an optional trailing Action<HttpLoggerOptions>:

builder.Logging.AddPacemHttpLogging(
    log => new HttpRequestMessage(HttpMethod.Post, "/ingest") { /* … */ },
    client => client.BaseAddress = new Uri("https://logs.example.com"),
    // don't ship our own transport noise back over HTTP
    options => options.Filter = log => !log.Name.StartsWith("System.Net.Http"));

Plans for version next

Optional client-side batching and a retry / dead-letter policy.