👁 Image
StackSpot.Logging 1.0.1

StackSpot logging

Este componente foi projetado para padronizar o log das aplicações.

Versões suportadas

• net5.0
• net6.0

Uso

1. Adicione o pacote NuGet StackSpot.Logging ao seu projeto.

dotnet add package StackSpot.Logging

Fornecemos pacotes adicionais que permitem realizar o logging do SpanId, TraceId e CorrelationId.

dotnet add package StackSpot.Logging.OpenTracing

dotnet add package StackSpot.Logging.Correlation

dotnet add package StackSpot.Logging.XRay

2. Configure as variáveis.

• APP_NAME - nome da aplicação - Campo Obrigatório
• LOG_LEVEL - level de log, valores: DEBUG, INFO, WARN, ERROR, FATAL.

Quando executar na máquina local, você pode configurar as variáveis de ambientes no arquivo launchSettings.json.

{
 "$schema": "http://json.schemastore.org/launchsettings.json",
 "profiles": {
 "Sample.WebApi": {
 "commandName": "Project",
 "launchBrowser": true,
 "launchUrl": "sample",
 "environmentVariables": {
 "APP_NAME": "MyAppName",
 "LOG_LEVEL": "INFO",
 "ASPNETCORE_ENVIRONMENT": "Development"
 },
 "applicationUrl": "http://localhost:5000"
 }
 }
}

Você pode configurar as variáveis no arquivo appsettings.json.

{
 "AppName": "MyAppName", 
 "LogOptions": {
 "LogLevel": "INFO"
 }
}

3. Adicione ao seu IServiceCollection via services.AddLogger() no Startup da aplicação ou Program.

Utilizando váriavel de ambiente

services.AddLogger();

Utilizando appsettings.json

services.AddLogger(Configuration);

Caso precise de um log completo com informações de contexto, instale os pacotes adicionais e utilize a configuração abaixo:

Exemplo OpenTracing:

services.AddLogger()
 .WithOpenTracing()
 .WithCorrelation();

Exemplo XRay:

services.AddLogger()
 .WithXRayTraceId()
 .WithCorrelation();

Implementação

Estendemos os métodos do ILogger<> transformado o output, adicionalmente estamos provendo duas sobrecargas novas para suportar TAGs e log de Objetos no campo Data.

[ApiController]
[Route("[controller]")]
public class SampleController : ControllerBase
{
 private readonly ILogger<SampleController> _logger;

 public SampleController(ILogger<SampleController> logger)
 {
 _logger = logger;
 }

 [HttpGet()]
 public async Task<IActionResult> Get()
 {
 var someEntity = new SampleEntity();
 _logger.LogDebug("My DEBUG Log Message", someEntity, "Tag01", "Tag02");
 return Ok();
 }
}

Sobrecargas disponíveis.

Debug

_logger.LogDebug("My DEBUG Log Message");
_logger.LogDebug("My DEBUG Log Message", "Tag01", "Tag02");
_logger.LogDebug("My DEBUG Log Message", someEntity, "Tag01", "Tag02");

Info

_logger.LogInformation("My INFO Log Message");
_logger.LogInformation("My INFO Log Message", "Tag01", "Tag02");
_logger.LogInformation("My INFO Log Message", someEntity, "Tag01", "Tag02");

Warning

_logger.LogWarning("My WARNING Log Message");
_logger.LogWarning("My WARNING Log Message", "Tag01", "Tag02");
_logger.LogWarning("My WARNING Log Message", someEntity, "Tag01", "Tag02");

Error

_logger.LogError("My ERROR Log Message");
_logger.LogError("My ERROR Log Message", "Tag01", "Tag02");
_logger.LogError("My ERROR Log Message", someEntity, "Tag01", "Tag02");

Fatal

_logger.LogFatal("My ERROR Log Message");
_logger.LogFatal("My ERROR Log Message", "Tag01", "Tag02");
_logger.LogFatal("My ERROR Log Message", someEntity, "Tag01", "Tag02");

Output completo

Mostramos abaixo o output completo preenchido com informações do dotnet.

{
 "timeStamp": "2021-04-06T14:50:33.6610795Z",
 "appName": "MyAppName",
 "message": "An unhandled exception has occurred while executing the request.",
 "logger": "Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware",
 "level": "ERROR",
 "tags": ["Tag01", "Tag02"],
 "data": {
 "field1": "Test01",
 "field2": "Test02"
 },
 "exception": {
 "name": "DivideByZeroException",
 "message": "Attempted to divide by zero.",
 "stackTrace": " at Sample.WebApi.Controllers.SampleController.Get() in ..."
 },
 "context": {
 "spanId": "1af157b8bee48886",
 "traceId": "1af157b8bee48886",
 "correlationId": "614bc03a1eab685315a897fe1405a935"
 }
}