LogFlake.Client.AspNetCore 1.8.3

LogFlake Client ASP.NET Core

This repository contains the sources for the client-side components of the LogFlake product suite for applications logs and performance collection for ASP.NET applications.

🏠 LogFlake Website | 🔥 CloudPhoenix Website

Downloads

NuGet Package Name	Version	Downloads
LogFlake.Client.AspNetCore

Dependencies

This package depends on LogFlake.Client.NetCore.
Please refer to the documentation of that package for usage instructions.

Usage

1. [Optional] If you want to customize some automatic logs from the middleware, add the following section to your secrets.json file:

"LogFlakeMiddlewareSettings": {
    "LogRequest": true,
    "LogResponse": true,
    "LogNotFoundErrors": true,
},

All of them are optional, if a boolean property it's missing, the default value is false;

2. Create a class (name it something like ConfigureLogFlakeMiddlewareOptions) that implements IConfigureOptions<LogFlakeMiddlewareOptions> and configure each property;
3. Register your class as a Singleton:

services.AddSingleton<IConfigureOptions<LogFlakeMiddlewareOptions>, ConfigureLogFlakeMiddlewareOptions>();

4. After calling services.AddLogFlake(configuration);, add the following line of code:

services.ConfigureLogFlakeMiddlewareOptions(configuration);

Note: You can choose between a Guid, a TraceIdentifier or a Custom correlation id.

Note: In order to use a Custom correlation id you must implement and register ICorrelationService interface (suggestion: as a AddScoped). 5. Register the middleware on your WebApplication

app.UseLogFlakeMiddleware();

6. If you need to add more parameter to log entries generated by the Middleware (such as data from Claims), you need to implement IParameterService interface and register as a Scoped before the services.ConfigureLogFlakeMiddlewareOptions(configuration); invocation.