EonaCat.Web.Tracer 1.0.1

EonaCat.Web.Tracer

EonaCat Web Tracer is a middleware to log every Http request and response for tracing.

To add the Middleware use the following code:

app.UseWebTracer();

You can also set specific options for the EonaCat.Web.Tracer using the code below:

WebTracerOptions tracerOptions = new WebTracerOptions();
tracerOptions.LogToConsole= true;
tracerOptions.IgnoreRequestQueryString = true;
tracerOptions.IgnoreRequests = true;
tracerOptions.IgnoreRequestBody = true;
tracerOptions.AddClientIpInformation = true;
tracerOptions.AddClientUserAgentInformation = true;
tracerOptions.AddCorrelationId = true;
tracerOptions.IgnoreResponse = true;
tracerOptions.IgnoreResponseBody = true;

app.UseWebTracer(tracerOptions);

Information about the options:

LogToConsole: Determines if we need to log to the console (default: true)

IgnoreRequestQueryString: Determines if we need to ignore the request Query String for logging (default: false)

IgnoreRequests: Determines if we need to ignore the requests for logging (default: false)

IgnoreRequestBody: Determines if we need to ignore the request body for logging (default: true)

AddClientIpInformation: Determines if we need to add the client ipAddress to the request and response (default: true)

AddClientUserAgentInformation: Determines if we need to add the client userAgent to the request and response (default: true)

AddCorrelationId: Determines if we need to add a correlation id for the request and response (default: true)

IgnoreResponse: Determines if we need to ignore the response for logging (default: false)

IgnoreResponseBody: Determines if we need to ignore the response body for logging (default: true)

Bind to logEvent:

You can also bind to a log event. This event will get triggered everytime a request/response should be logged. (also triggers when LogToConsole is disabled)

WebTracer.OnLog += WebTracer_OnLog;
void WebTracer_OnLog(object? sender, string message)
{
    Console.WriteLine(message);
}