DMS.ErrorHandler 1.0.0

DMS.ErrorHandler

Autor: Fredy Fuentes Fecha de Creación: 2025-03-20

📜 Descripción

Biblioteca para manejo centralizado de errores en aplicaciones .NET. Permite registrar excepciones en un archivo de log, capturar errores no controlados con middleware y devolver respuestas JSON estructuradas. Ideal para APIs REST y aplicaciones ASP.NET Core.

📝 Características Principales

• Registro de errores: Guarda excepciones con detalles como clase, método, línea y mensaje.
• Middleware integrado: Captura errores globales y devuelve respuestas JSON amigables.
• Gestión de logs: Lectura y ordenamiento de entradas por fecha.
• Configuración flexible: Tamaño máximo de archivo, rutas personalizadas y opción de guardar en disco.

📖 Ejemplos de Uso

📖 Registrar el manejador de errores en el contenedor de dependencias

using DMS.ErrorHandler.Extensions;

builder.Services.AddDMSErrorHandler(options =>
{
	options.LogFilePath = "error.log";
	options.MaxLogFileSize = 10 * 1024 * 1024; // 10 MB
	options.SaveToFile = true;
});

📖 Agrega el middleware de manejo de errores a la canalización

app.UseDMSErrorHandler();

📖 Registrar Errores Manualmente

using DMS.ErrorHandler.Logging;

var logger = serviceProvider.GetRequiredService<IErrorLogger>();

try	{
	// Código que puede lanzar una excepción
}
catch (Exception ex)
{
	var logEntry = logger.LogError(ex);
	Console.WriteLine(logEntry.ToString());
}

📖 Leer y Ordenar el Archivo de Log

var logger = serviceProvider.GetRequiredService<IErrorLogger>();
var logEntries = logger.ReadLogFileOrdered(descending: true);

foreach (var entry in logEntries)
{
    Console.WriteLine(entry.ToString());
}

📖 Respuesta JSON en Caso de Errores no controlados

{
  "IsSuccess": false,
  "Message": "Se ha producido un error.",
  "Error": {
    "Date": "2025-03-19 12:34:56",
    "Class": "MyController",
    "Method": "Get",
    "Line": "42 (StackTrace - line 42)",
    "Exception": "Error de operación no válida."
  }
}

🚀 Instalación

Puedes instalar el paquete desde NuGet con:

dotnet add package DMS.ErrorHandler

🛠 Compatibilidad

• .NET 7.0+
• .NET 8.0+
• .NET 9.0+

⚠️ Mejores Prácticas

• Middleware: Colócalo al inicio de la aplicación para capturar todos los errores.
• Tamaño de logs: Configura MaxLogFileSize para evitar archivos muy grandes.`
• Logs sensibles: No guardes información sensible en los logs.
• Entornos: En producción, evita exponer detalles sencibles en respuestas JSON.

📄 Documentación Completa

📄 Licencia

Este proyecto se encuentra bajo la licencia Apache2-0.

📌 Cómo Contribuir

Si deseas contribuir, revisa el archivo CONTRIBUTING.md para más detalles.

📜 Changelog

Para ver los cambios en cada versión, consulta el archivo CHANGELOG.md.