117 lines
3.8 KiB
TypeScript
117 lines
3.8 KiB
TypeScript
/*
|
|
* SPDX-FileCopyrightText: syuilo and other misskey contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
|
|
import cluster from 'node:cluster';
|
|
import { pino } from 'pino';
|
|
import { bindThis } from '@/decorators.js';
|
|
import { envOption } from './env.js';
|
|
import type { KEYWORD } from 'color-convert/conversions.js';
|
|
|
|
// eslint-disable-next-line import/no-default-export
|
|
export default class Logger {
|
|
private readonly domain: string;
|
|
private logger: pino.Logger;
|
|
|
|
constructor(domain: string, _color?: KEYWORD, _store = true, parentLogger?: Logger) {
|
|
if (parentLogger) {
|
|
this.domain = parentLogger.domain + '.' + domain;
|
|
} else {
|
|
this.domain = domain;
|
|
}
|
|
|
|
this.logger = pino({
|
|
name: this.domain,
|
|
level: envOption.verbose ? 'debug' : 'info',
|
|
depthLimit: 8,
|
|
edgeLimit: 128,
|
|
redact: ['context.password', 'context.token'],
|
|
enabled: !envOption.quiet || envOption.logJson,
|
|
timestamp: envOption.withLogTime || envOption.logJson ? pino.stdTimeFunctions.isoTime : false,
|
|
messageKey: 'message',
|
|
errorKey: 'error',
|
|
mixin: () => ({ cluster: cluster.isPrimary ? 'primary' : `worker#${cluster.worker!.id}` }),
|
|
transport: !envOption.logJson ? {
|
|
target: 'pino-pretty',
|
|
options: {
|
|
levelFirst: false,
|
|
levelKey: 'level',
|
|
timestampKey: 'time',
|
|
messageKey: 'message',
|
|
errorLikeObjectKeys: ['e', 'err', 'error'],
|
|
ignore: 'pid,hostname,cluster,important',
|
|
messageFormat: '@{cluster} | {message}',
|
|
},
|
|
} : undefined,
|
|
});
|
|
}
|
|
|
|
@bindThis
|
|
public createSubLogger(domain: string, _color?: KEYWORD, _store = true): Logger {
|
|
return new Logger(domain, undefined, false, this);
|
|
}
|
|
|
|
@bindThis
|
|
public error(x: string | Error, context?: Record<string, any> | null, important = false): void { // 実行を継続できない状況で使う
|
|
if (context === null) context = undefined;
|
|
|
|
if (x instanceof Error) {
|
|
context = context ?? {};
|
|
context.error = x;
|
|
|
|
if (important) this.logger.fatal({ context, important }, x.toString());
|
|
else this.logger.error({ context, important }, x.toString());
|
|
} else if (typeof x === 'object') {
|
|
context = context ?? {};
|
|
context.error = context.error ?? x;
|
|
|
|
if (important) this.logger.fatal({ context, important }, `${(x as any).message ?? (x as any).name ?? x}`);
|
|
else this.logger.error({ context, important }, `${(x as any).message ?? (x as any).name ?? x}`);
|
|
} else {
|
|
if (important) this.logger.fatal({ context, important }, x);
|
|
else this.logger.error({ context, important }, x);
|
|
}
|
|
}
|
|
|
|
@bindThis
|
|
public warn(x: string | Error, context?: Record<string, any> | null, important = false): void { // 実行を継続できるが改善すべき状況で使う
|
|
if (context === null) context = undefined;
|
|
|
|
if (x instanceof Error) {
|
|
context = context ?? {};
|
|
context.error = x;
|
|
|
|
this.logger.warn({ context, important }, x.toString());
|
|
} else if (typeof x === 'object') {
|
|
context = context ?? {};
|
|
context.error = context.error ?? x;
|
|
|
|
this.logger.warn({ context, important }, `${(x as any).message ?? (x as any).name ?? x}`);
|
|
} else {
|
|
this.logger.warn({ context, important }, x);
|
|
}
|
|
}
|
|
|
|
@bindThis
|
|
public succ(message: string, context?: Record<string, any> | null, important = false): void { // 何かに成功した状況で使う
|
|
if (context === null) context = undefined;
|
|
|
|
this.logger.trace({ context, important }, message);
|
|
}
|
|
|
|
@bindThis
|
|
public debug(message: string, context?: Record<string, any> | null, important = false): void { // デバッグ用に使う(開発者に必要だが利用者に不要な情報)
|
|
if (context === null) context = undefined;
|
|
|
|
this.logger.debug({ context, important }, message);
|
|
}
|
|
|
|
@bindThis
|
|
public info(message: string, context?: Record<string, any> | null, important = false): void { // それ以外
|
|
if (context === null) context = undefined;
|
|
|
|
this.logger.info({ context, important }, message);
|
|
}
|
|
}
|