#Logger

#Create Logger

#createLogger()

Creates a custom logger.

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

#Details

#createSystemLogger()

Creates system runtime logs printed in a specified method. Refer to Logger - System Log

#Signature

• createSystemLogger(options: SystemLoggerOptions)

#Type

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

#Details

#requestLogger()

Middleware for API request and response logging.

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

#Details

#app.createLogger()

#Definition

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

When dirname is a relative path, the log files will be output to the directory named after the current application.

#plugin.createLogger()

Usage is the same as app.createLogger().

#Definition

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

#Log Configuration

#getLoggerLevel()

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

Gets the log level currently configured in the system.

#getLoggerFilePath()

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

Concatenates directory paths based on the log directory currently configured in the system.

#getLoggerTransports()

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

Gets the log output methods currently configured in the system.

#getLoggerFormat()

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

Gets the log format currently configured in the system.

#Log Output

#Transports

Predefined output methods.

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

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

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

#Related Documentation

• Development Guide - Logger
• Logger