#المسجل

#إنشاء مسجل

#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()

وسيط (Middleware) لتسجيل طلبات واستجابات الواجهة البرمجية (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({
  //...
});

#الوثائق ذات الصلة

• دليل التطوير - المسجل
• المسجل