#Logger

#Créer un Logger

#createLogger()

Crée un logger personnalisé.

#Signature

• createLogger(options: LoggerOptions)

#Type

interface LoggerOptions
  extends Omit<winston.LoggerOptions, 'transports' | 'format'> {
  dirname?: string;
  filename?: string;
  format?: 'logfmt' | 'json' | 'delimiter' | 'console' | winston.Logform.Format;
  transports?: ('console' | 'file' | 'dailyRotateFile' | winston.transport)[];
}

#Détails

#createSystemLogger()

Crée les logs d'exécution système selon une méthode spécifiée. Référez-vous à Logger - Log système

#Signature

• createSystemLogger(options: SystemLoggerOptions)

#Type

export interface SystemLoggerOptions extends LoggerOptions {
  seperateError?: boolean; // imprime les erreurs séparément, par défaut à true
}

#Détails

#requestLogger()

Middleware pour la journalisation des requêtes et réponses d'API.

app.use(requestLogger(app.name));

#Signature

• requestLogger(appName: string, options?: RequestLoggerOptions): MiddewareType

#Type

export interface RequestLoggerOptions extends LoggerOptions {
  skip?: (ctx?: any) => Promise<boolean>;
  requestWhitelist?: string[];
  responseWhitelist?: string[];
}

#Détails

#app.createLogger()

#Définition

class Application {
  createLogger(options: LoggerOptions) {
    const { dirname } = options;
    return createLogger({
      ...options,
      dirname: getLoggerFilePath(this.name || 'main', dirname || ''),
    });
  }
}

Lorsque dirname est un chemin relatif, les fichiers de log seront générés dans le répertoire portant le nom de l'application actuelle.

#plugin.createLogger()

L'utilisation est identique à celle de app.createLogger().

#Définition

class Plugin {
  createLogger(options: LoggerOptions) {
    return this.app.createLogger(options);
  }
}

#Configuration des logs

#getLoggerLevel()

getLoggerLevel(): 'debug' | 'info' | 'warn' | 'error'

Récupère le niveau de log actuellement configuré dans le système.

#getLoggerFilePath()

getLoggerFilePath(...paths: string[]): string

Concatène les chemins de répertoires en se basant sur le répertoire de logs actuellement configuré dans le système.

#getLoggerTransports()

getLoggerTransports(): ('console' | 'file' | 'dailyRotateFile')[]

Récupère les méthodes de sortie des logs actuellement configurées dans le système.

#getLoggerFormat()

getLoggerFormat(): 'logfmt' | 'json' | 'delimiter' | 'console'

Récupère le format des logs actuellement configuré dans le système.

#Sortie des logs

#Transports

Méthodes de sortie prédéfinies.

• Transports.console
• Transports.file
• Transports.dailyRotateFile

import { Transports } from '@nocobase/logger';

const transport = Transports.console({
  //...
});

#Documentation associée

• Guide de développement - Logger
• Logger