@clavisco/logs-viewer

Logs viewer es una interfaz de usuario interactiva diseñada para la revision de archivos logs de texto generados por la aplicación, permite visualizar toda la estrucutra de archivos y carpetas que tiene la carpeta base de logs de la aplicación, permitiendo descargar y visualizar los archivos de logs desde la aplicacion. Esto con el fin de agilizar el proceso de revision de logs para el departamento de soporte o para cualquier otro usuario que quiera ver los registros de logs.

Tabla de contenido

• Paquetes y dependencias requeridas
• Resumen de la versión
• Instalación
• ¿Cómo lo implemento?
• API de referencia

Paquetes y dependencias requeridas

• @angular/cdk ^13.2.5
• @angular/common ^13.0.0
• @angular/core ^13.0.0
• @angular/material ^13.2.5
• @clavisco/core ^0.2.4
• @clavisco/linker ^0.0.15
• @clavisco/table ^1.5.0-beta.0

Resumen de la versión

• Mostrar archivos de logs y sub-carpetas de logs en una tabla
• Filtrar archivos y carpetas por nombre
• Descargar archivos de logs

Instalación

npm i @clavisco/logs-viewer

¿Cómo lo implemento?

1. Instalar componentes npm i @clavisco/core@^0.2.4 @clavisco/linker@^0.0.15 @clavisco/table@^1.5.0-beta.0 @clavisco/logs-viewer.
2. Importaciones de modulos y servicios:
   • import { MatFormFieldModule } from '@angular/material/form-field';
   • import { TableModule } from '@clavisco/table';
   • import { LinkerService } from '@clavisco/linker';
   • import { MatIconModule } from '@angular/material/icon';
   • import { MatInputModule } from '@angular/material/input';
   • import { MatButtonModule } from '@angular/material/button';
   • import { MatTooltipModule } from '@angular/material/tooltip';
   • import { CommonModule } from '@angular/common';
   • import { ReactiveFormsModule } from '@angular/forms';
3. Agregar al array de imports los modulos y al array de providers los servicios.
4. El servicio de linker ser debe proveer de la siguiente manera: { provide: 'LinkerService', useClass: LinkerService }
5. En el componente donde vayamos a utilizar @clavisco/logs-viewer, debemos agregar esta etiqueta:

   my.component.ts

       @Component({
           selector: 'my-component',
           templateUrl: './my.component.html',
           styleUrls: ['./my.component.scss']
       })
       export class MyComponent implements OnInit, AfterViewInit {
           componentId: string = "logsViewerComponentId";
       }

   my.component.html

       <cl-logs-viewer [componentId]="componentId"></cl-logs-viewer>

   La propiedad componentIdrepresenta el identificador del logs viewer componente tanto en el DOM como en LinkerService.
6. La comunicacion con el componente se explica en API de referencia
7. Listo, así se implementa el componente logs-viewer.

Api de referencia

Esta sección muestra todas las características disponibles y especificaciónes del consumo de estas.

Clase: LinkerService
Nombre: Publish
Tipo de retorno: void
Descripción: Este canal es utilizado para agregar y renderizar los archivos y sub-directorios de la ruta base de Logs. El objeto que debe recibir el metodo debe ser el siguiente:

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:--------------|-----------------------|:-------------------------------------------------------------------------------|-----------|------------| | CallBack | CL_CHANNEL | Canal por el cual se va a realizar al comunicacion con le componente | INFLATE | Sí | | Data | string | Objeto @clavisco/logs-viewer.IDirectoryItem[] serializado | | Sí | | Target | string | Identificador del componente, valor pasado por la propiedad componentId | | Sí |

Clase: LinkerService
Nombre: Publish
Tipo de retorno: void
Descripción: Este canal es utilizado para la descarga el archivo en base 64, hace referencia al archivo de log txt. El objeto que debe recibir el metodo debe ser el siguiente:

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:--------------|-----------------------|:-------------------------------------------------------------------------------|---------------|------------| | CallBack | CL_CHANNEL | Canal por el cual se va a realizar al comunicacion con le componente | DATA_LINE_1 | Sí | | Data | string | Objeto @clavisco/logs-viewer.IBrowserDownloadFile | | Sí | | Target | string | Identificador del componente, valor pasado por la propiedad componentId | | Sí |

Clase: LinkerService
Nombre: Publish
Tipo de retorno: void
Descripción: Este canal es utilizado para iniciar el proceso de consulta de archivos de logs al servidor:

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:--------------|-----------------------|:-------------------------------------------------------------------------------|-------------------|------------| | CallBack | CL_CHANNEL | Canal por el cual se va a realizar al comunicacion con le componente | PRE_REQ_RECORDS | Sí | | Data | string | String vacio | | Sí | | Target | string | Identificador del componente, valor pasado por la propiedad componentId | | Sí |

Clase: Método global de @clavisco/linker
Nombre: Register
Tipo de retorno: void
Descripción: Este canal se ejecuta cada vez que se requieren consultar archivos de logs

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:------------------|-----------------------------------|:------------------------------------------------------------------------------------|--------------------|------------| | _componentId | string | Identificador del componente con el cual se va a comunicar | | Sí | | _action | CL_CHANNEL | Canal que se debe escuchar para manejar la navegacion a directorios | REQUEST_RECORDS | Sí | | _callback | Function | Función que se va a ejecutar como manejador del evento del canal INPUT | | Sí | | _interface | ICLCallbacksInterface<CL_CHANNEL> | Objeto utilizado para registrar el callback | | Sí |

Clase: Método global de @clavisco/linker
Nombre: Register
Tipo de retorno: void
Descripción: Este canal se ejecuta cuando se quiere descargar un archivo de log

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:------------------|-----------------------------------|:---------------------------------------------------------------------------------------|------------|------------| | _componentId | string | Identificador del componente con el cual se va a comunicar | | Sí | | _action | CL_CHANNEL | Canal que se debe escuchar para manejar la solicitud de descarga de una archivo de log | INPUT | Sí | | _callback | Function | Función que se va a ejecutar como manejador del evento del canal INPUT | | Sí | | _interface | ICLCallbacksInterface<CL_CHANNEL> | Objeto utilizado para registrar el callback | | Sí |

ClavisCo © - 2025

Keywords

logs log logs-viewer files