Blip.Starter.Common.Logs 0.0.27

Blip.Starter.Common.Logs

First of all, please read all pages of our Logging documentation.

You must configure your application to be able to have its logs collected correctly.

Configuring your application

.NET

Add Blip.Starter.Common.Traces NuGet package to your project to configure your application.

The NuGet package is published in our private NuGet repository: https://dev.azure.com/curupira/BLiP/_artifacts/feed/BlipNuget/NuGet/Blip.Starter.Common.Traces/overview/0.0.9

To access it locally you will need to install Azure Artifacts credential provider.

ASP.NET Core

Then, in your Startup.cs file or anywhere you configure the framework, add the following code:

// You can change the configuration if needed
ILogConfiguration configuration = DefaultLogConfiguration();
 
// Create the environment with correct values (read it from your configuration or environment variables)
Env.Environment environment = new Env.Environment("your-app-deploy-name", "your-app-deploy-version", "the-cluster-your-app-is-deployed");

// Integrate the Serilog log sink with the IServiceCollection using the extension from LogSinkExtension
services.AddLogSink(configuration, environment);

You can also use the .NET IConfiguration interface having the fields LogSink for the ILogConfiguration and $Metadata for the Env.Environment to configure your application as following:

// This is an example of how to get the configuration from the builder, but this code will already be in your application
var builder = WebApplication.CreateBuilder(args);
IConfiguration config = builder.Configuration;

builder.Services.AddLogSink(config);

Manual configuration

If you must configure Serilog sink manually because you do not use ASP.NET Core, you can do it like this:

// You can change the configuration if needed
ILogConfiguration configuration = DefaultLogConfiguration();

// Create the environment with correct values (read it from your configuration or environment variables)
Env.Environment environment = new Env.Environment("your-app-deploy-name", "your-app-deploy-version", "the-cluster-your-app-is-deployed");

Log.Logger = LoggerSimpleStarter.Create(loggerConfiguration, environment).CreateLogger();

Sending logs to Grafana Loki

After configuring the instrumentation, there is a few things you must ensure to have your logs sent to Grafana Loki.

Please read the documentation to know what to do.

Please make sure your cluster already have a Promtail configured by asking to SRE team.