Cl.Core.Addons.LogsViewer 1.0.0-alpha

Acerca de Cl.Core.Addons.LogsViewer

Conjuto de funcionalidades que facilitan la gestión y operación del componente logs-viewer. Este paquete permite realizar operaciones como consulta de archivos y generacion de información para descarga de archivos.

¿Qué resuelve?

Este paquete soluciona la gestion de consultas de archivos y directorios de logs, esenciales para el correcto funcionamiento del componente @clavisco/logs-viewer

Rutinas

Nota

Para la implementación de las rutinas de creación y actualización es indispensable contar con la siguiente implementación:

En el Program.cs del proyecto, configurar la inyección de dependencias de la siguiente manera:

builder.Services.AddScoped<Cl.Core.Structures.Interfaces.Common.ILogManager, Cl.Core.Common.LogManager>();
builder.Services.AddScoped<Cl.Core.Structures.Interfaces.Common.ISettings, Cl.Core.Common.Settings>();
builder.Services.AddScoped<Cl.Core.Addons.LogsViewer.ILogsViewer, Cl.Core.Addons.LogsViewer.LogsViewer>();

DownloadLogsDirectoryFile (System.String) : Cl.Core.Structures.Classes. Rebound.BrowserDownloadFile

Descripción

Genera la información necesaria para la descarga del archivo de logs desde un navegador.

Parametros

• _filePath (Requerido): Ruta del archivo que se quiere descargar.

Ejemplo

public CLContext<BrowserDownloadFile> MyMethod(string _filePath)
{
    BrowserDownloadFile downloadFile = _logsViewer.DownloadLogsDirectoryFile(_filePath);

    return new CLContext<BrowserDownloadFile>(){
        Response = new Response<BrowserDownloadFile>(){
            Data = downloadFile
        }
    }
}

GetLogsDirectoryItems (System.String?) : IEnumerable<Cl.Core.Structures.Classes.LogsViewer.DirectoryItem>

Descripción

Lee el directorio de logs que se especifica por parametros, en caso de que no se especifique uno, buscar la propiedad "LogPath" en las propiedades del appsettings.json.

Parametros

• _logsPath (Opcional): Ruta de la cual se van a consultar los archivos de logs, en caso de no especificarse una, se buscara por la configurada en la propiedad "LogPath" del appsettings.json.

Ejemplo

public CLContext<IEnumerable<DirectoryItem>> GetDirectoryItems(string directoryPath = null)
{
    List<Cl.Core.Structures.Classes.LogsViewer.DirectoryItem> response = _logsViewer.GetLogsDirectoryItems(directoryPath);

    return new CLContext<IEnumerable<DirectoryItem>>()
    {
        Response = new Response<IEnumerable<DirectoryItem>>()
        {
            Data = response,
            Message = "Logs retrieved successful."
        }
    };
}