Angular Logging

Librería Angular para el manejo del logging. Brinda las siguientes funcionálidades clave:

• logueo por niveles
• seteo del nivel de logging en runtime, incluso desde las DevTools del navegador
• posibilidad de almacenamiento y consulta de logs localmente en el navegador usando IndexedDB
• posibilidad de reporte de logs a Sentry

Está pensada para poder setear el nivel de logging en runtime, incluso utilizando las DevTools, de forma de poder incrementar el nivel de logging de una app corriendo en producción.

Además, el almacenamiento de los logs en IndexeDB puede ser muy util cuando se está offline y hay determinados logs que se necesitarían enviar al server. Al recuperar la conexión estos logs pueden ser obtenidos y enviados.

También puede resultar muy útil en dispositivos móviles donde no se pueden ver los logs en la consola JS. En este caso pueden ser obtenidos bajo demanda de IndexedDB para ser mostrados en pantalla.

Uso

Si se desea usar el reporte externo a Sentry entonces Instalar @sentry/browser.

Se debe importar el módulo en el AppModule y además se debe incluir un Provider para el token ANGULAR_LOGGING_CONFIG el cual debe proveer un objeto AngularLoggingConfig con toda la configuración para el módulo.
La forma de definir este Provider puede ser cualquiera, dependiendo de las necesidades de cada app. En el ejemplo mostrado se realiza mediante una factory porque se representa que se tiene una dependencia con un AuthService al cual se le pide el usuario logueado, y se requiere hacer de esta forma para tener acceso al mismo. Pero si por ejemplo se trata de una app simple donde el usuario que se quiere informar en los logs es fijo entonces se puede definir directamente el provider mediante useValue sin requerir una factory.

import { AngularLoggingModule, AngularLoggingService, LogLevel } from 'angular-logging';

export function getLoggingConfig(auth: AuthService): AngularLoggingConfig {
    return {
        defaultLevel: environment.production ? LogLevel.INFO : LogLevel.DEBUG,
        console: { use: true, saveExtras: true },
        localDB: {
            use: true,
            databasePrefix: 'xxx',
            levelFrom: environment.production ? LogLevel.WARN : LogLevel.INFO
        },
        externalService: {
            use: true,
            levelFrom: LogLevel.WARN,
            options: [{
                dsn: 'xxxxxxxxxxxxxx',
                environment: 'xxxxx',
                // indica la cantidad de niveles cuando se procesan los objetos de info del evento
                normalizeDepth: 6
            }]
        },
        userProvider: () => {
          // ejemplo suponiendo que tenemos un AuthService con una operacion getLoggedUser
            const loggeduser = auth.getLoggedUser();
            return {
                id: loggeduser ? `${loggeduser.id} (${loggeduser.name})` : '-1',
                username: loggeduser ? loggeduser.name : 'SIN USER'
            };
        }
    };
}

// se customiza el ErrorHandler de Angular para que loguee a traves del AngularLoggingService
@Injectable()
export class CustomErrorHandler implements ErrorHandler {
  constructor(private logging: AngularLoggingService) {}
  handleError(error) {
    this.logging.error({error: error.originalError || error});
    throw error;
  }
}

// se importa y configura el AngularLoggingModule
@NgModule({
  imports: [AngularLoggingModule]
  providers: [
    { provide: ErrorHandler, useClass: CustomErrorHandler, deps: [AngularLoggingService] },
    { provide: ANGULAR_LOGGING_CONFIG, useFactory: getLoggingConfig, deps: [AuthService] }
  ],
})
export class AppModule {}

Soporte offline en servicio externo

Para dar un soporte offline al reporte de logs en servicio externo se debe hacer mediante Background Sync.

Para el caso de Sentry, que es el único servicio externo soportado por el momento, se debe indicar al Service Worker que los POST que hace Sentry para enviar el evento, se encole en caso de que no haya conexión y se reintente luego autoimáticamente. Para hacer esto agregar el siguiente código en el SW:

const bgSyncPlugin = new workbox.backgroundSync.Plugin('SentryBackSync', {
    maxRetentionTime: 24 * 60
});

// registro que para las llamadas a la API de Sentry se utilice Background Sync
workbox.routing.registerRoute(
    new RegExp(/https:\/\/sentry.io\/api(.)*/),
    new workbox.strategies.NetworkOnly({
        plugins: [bgSyncPlugin]
    }),
    'POST'
);