EasyLoggerBG 1.0.0

Documentación de Uso - Librería de Logging

Instalación

Para utilizar esta librería de logging en tu proyecto, necesitas:

1. Instalar el paquete NuGet de la librería (por ejemplo: MyCompany.Logging)
2. Configurar los settings en tu archivo de configuración (opcional para Elasticsearch)
3. Inicializar el logger en tu aplicación

Modos de Uso

1. Solo Logging en Archivos

Si solo necesitas logging en archivos locales:

builder.Host.AddCustomLogging();

2. Con Elasticsearch (Configuración Básica)

Para usar Elasticsearch sin autenticación:

var config = new ElasticConfiguration 
{ 
    Url = "http://elasticsearch:9200",
    IndexPrefix = "mi-app-logs",
    ApplicationName = "MiAplicacion"
};
builder.Host.AddCustomLogging(config);

3. Con Elasticsearch (Configuración Completa)

Para usar todas las características con configuración en appsettings.json:

var config = builder.Configuration
    .GetSection(LoggingConstants.ElasticConfig)
    .Get<ElasticConfiguration>();
builder.Host.AddCustomLogging(config);

Configuración en appsettings.json

{
  "ElasticConfig": {
    "Url": "http://elasticsearch:9200",
    "Username": "elastic",        // Opcional
    "Password": "password",       // Opcional
    "IndexPrefix": "mi-app-logs",
    "ApplicationName": "MiAplicacion",
    "NumberOfReplicas": 1,
    "NumberOfShards": 2
  }
}

Descripción de los Parámetros

• Url: URL del servidor Elasticsearch
• Username: (Opcional) Usuario para autenticación
• Password: (Opcional) Contraseña para autenticación
• IndexPrefix: Prefijo para los índices de Elasticsearch
• ApplicationName: Nombre de tu aplicación
• NumberOfReplicas: Número de réplicas en Elasticsearch
• NumberOfShards: Número de shards en Elasticsearch

Características del Logging

Logs en Archivos (Siempre activo)

• Archivos separados por nivel:
  • logs/info-log-.txt
  • logs/warning-log-.txt
  • logs/error-log-.txt

Elasticsearch (Cuando está configurado)

• Índices mensuales automáticos
• Buffer local para fallos
• Autenticación opcional
• Manejo de fallos automático

Enriquecimiento de Logs

Siempre incluye:

• Nombre del ambiente
• Nombre de la máquina
• ID del thread

Con Elasticsearch configurado añade:

• Nombre de la aplicación

Rotación de Archivos

• Rotación diaria automática
• Retención de 30 días
• Límite de 10MB por archivo

Manejo de Errores y Resiliencia

La librería incluye las siguientes características de resiliencia:

1. Si Elasticsearch no está disponible:

   • Los logs se guardan en archivos locales
   • Los fallos se registran en logs/elastic-failures.txt

2. Si la configuración de Elasticsearch es inválida o nula:

   • El componente de Elasticsearch se omite automáticamente
   • El logging continúa funcionando con archivos locales

3. Si las credenciales están vacías:

   • La autenticación se omite
   • Se intenta conexión sin autenticación

Ejemplo de Uso en Código

public class MiServicio
{
    private readonly ILogger<MiServicio> _logger;

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

    public void MiMetodo()
    {
        _logger.LogInformation("Mensaje de información");
        _logger.LogWarning("Mensaje de advertencia");
        _logger.LogError("Mensaje de error");
    }
}

Notas Importantes

• La carpeta logs se crea automáticamente
• Verifica permisos de escritura en la carpeta de logs
• La configuración de Elasticsearch es completamente opcional
• Los logs nunca se pierden, incluso si Elasticsearch falla