#Логгер

#Создание логгера

#createLogger()

Создает пользовательский логгер.

#Сигнатура

• createLogger(options: LoggerOptions)

#Тип

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)[];
}

#Подробности

#createSystemLogger()

Создает системные логи выполнения, выводимые указанным способом. Подробнее см. в разделе Логгер - Системный лог.

#Сигнатура

• createSystemLogger(options: SystemLoggerOptions)

#Тип

export interface SystemLoggerOptions extends LoggerOptions {
  seperateError?: boolean; // print error seperately, default true
}

#Подробности

#requestLogger()

Промежуточное ПО для логирования запросов и ответов API.

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

#Сигнатура

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

#Тип

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

#Подробности

#app.createLogger()

#Определение

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

Если dirname является относительным путем, файлы логов будут выводиться в каталог, названный в честь текущего приложения.

#plugin.createLogger()

Использование аналогично app.createLogger().

#Определение

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

#Конфигурация логов

#getLoggerLevel()

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

Получает текущий уровень логирования, настроенный в системе.

#getLoggerFilePath()

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

Объединяет пути к каталогам на основе каталога логов, настроенного в системе.

#getLoggerTransports()

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

Получает текущие методы вывода логов, настроенные в системе.

#getLoggerFormat()

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

Получает текущий формат логов, настроенный в системе.

#Вывод логов

#Transports

Предопределенные методы вывода.

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

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

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

#Связанная документация

• Руководство по разработке - Логгер
• Логгер