sendnrw/misskey
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

enhance(logging): ログの処理をpinoに置き換える (MisskeyIO#364)

Browse Source
This commit is contained in:
まっちゃとーにゅ
2024-01-16 22:13:35 +09:00
committed by GitHub
parent 6fa77ef575
commit ecd4607f3d
5 changed files with 173 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/backend/package.json
View File

@@ -146,6 +146,8 @@
"otpauth": "9.2.1",
"parse5": "7.1.2",
"pg": "8.11.3",
"pino": "8.17.2",
"pino-pretty": "10.3.1",
"pkce-challenge": "4.0.1",
"probe-image-size": "7.2.3",
"promise-limit": "2.7.0",

2
packages/backend/src/core/LoggerService.ts
View File

@@ -16,6 +16,6 @@ export class LoggerService {
@bindThis
public getLogger(domain: string, color?: KEYWORD | undefined, store?: boolean) {
return new Logger(domain, color, store);
return new Logger(domain);
}
}

213
packages/backend/src/logger.ts
View File

@@ -4,182 +4,113 @@
*/
import cluster from 'node:cluster';
import util from 'node:util';
import chalk from 'chalk';
import { default as convertColor } from 'color-convert';
import { format as dateFormat } from 'date-fns';
import { pino } from 'pino';
import { bindThis } from '@/decorators.js';
import { envOption } from './env.js';
import type { KEYWORD } from 'color-convert/conversions.js';
util.inspect.defaultOptions = envOption.logJson ? {
showHidden: false,
depth: null,
colors: false,
customInspect: true,
showProxy: false,
maxArrayLength: null,
maxStringLength: null,
breakLength: Infinity,
compact: true,
sorted: false,
getters: false,
numericSeparator: false,
} : {
showHidden: false,
depth: null,
colors: true,
customInspect: true,
showProxy: false,
maxArrayLength: null,
maxStringLength: null,
breakLength: Infinity,
compact: true,
sorted: false,
getters: false,
numericSeparator: false,
};
type Context = {
name: string;
color?: KEYWORD;
};
type Level = 'error' | 'success' | 'warning' | 'debug' | 'info';
function inspect(_: string, value: any): null | string | number | boolean {
if (value === null || value === undefined) return null;
if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') return value;
if (value instanceof Date) return value.toISOString();
return util.inspect(value);
}
// eslint-disable-next-line import/no-default-export
export default class Logger {
private context: Context;
private parentLogger: Logger | null = null;
private store: boolean;
private readonly domain: string;
private logger: pino.Logger;
constructor(context: string, color?: KEYWORD, store = true) {
this.context = {
name: context,
color: color,
};
this.store = store;
}
@bindThis
public createSubLogger(context: string, color?: KEYWORD, store = true): Logger {
const logger = new Logger(context, color, store);
logger.parentLogger = this;
return logger;
}
@bindThis
private log(level: Level, message: string, data?: Record<string, any> | null, important = false, subContexts: Context[] = [], store = true): void {
if (envOption.quiet && !envOption.logJson) return;
if (!this.store) store = false;
if (level === 'debug') store = false;
if (this.parentLogger) {
this.parentLogger.log(level, message, data, important, [this.context].concat(subContexts), store);
return;
}
if (envOption.logJson) {
console.log(JSON.stringify({
time: new Date().toISOString(),
level: level,
message: message,
data: data,
important: important,
context: [this.context].concat(subContexts).map(d => d.name).join('.'),
cluster: cluster.isPrimary ? 'primary' : `worker-${cluster.worker!.id}`,
}, inspect));
return;
}
const time = dateFormat(new Date(), 'HH:mm:ss');
const worker = cluster.isPrimary ? '*' : cluster.worker!.id;
const l =
level === 'error' ? important ? chalk.bgRed.white('ERR ') : chalk.red('ERR ') :
level === 'warning' ? chalk.yellow('WARN') :
level === 'success' ? important ? chalk.bgGreen.white('DONE') : chalk.green('DONE') :
level === 'debug' ? chalk.gray('VERB') :
level === 'info' ? chalk.blue('INFO') :
null;
const contexts = [this.context].concat(subContexts).map(d => d.color ? chalk.rgb(...convertColor.keyword.rgb(d.color))(d.name) : chalk.white(d.name));
const m =
level === 'error' ? chalk.red(message) :
level === 'warning' ? chalk.yellow(message) :
level === 'success' ? chalk.green(message) :
level === 'debug' ? chalk.gray(message) :
level === 'info' ? message :
null;
let log = `${l} ${worker}\t[${contexts.join(' ')}]\t${m}`;
if (envOption.withLogTime) log = chalk.gray(time) + ' ' + log;
const args: unknown[] = [important ? chalk.bold(log) : log];
if (data != null) {
args.push(JSON.stringify(data, inspect, 2));
}
if (level === 'error' || level === 'warning') {
console.error(...args);
constructor(domain: string, _color?: KEYWORD, _store = true, parentLogger?: Logger) {
if (parentLogger) {
this.domain = parentLogger.domain + '.' + domain;
} else {
console.log(...args);
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 error(x: string | Error, data?: Record<string, any> | null, important = false): void { // 実行を継続できない状況で使う
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) {
data = data ?? {};
data.error = x;
context = context ?? {};
context.error = x;
this.log('error', x.toString(), data, important);
if (important) this.logger.fatal({ context, important }, x.toString());
else this.logger.error({ context, important }, x.toString());
} else if (typeof x === 'object') {
data = data ?? {};
data.error = data.error ?? x;
context = context ?? {};
context.error = context.error ?? x;
this.log('error', `${(x as any).message ?? (x as any).name ?? x}`, data, important);
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 {
this.log('error', `${x}`, data, important);
if (important) this.logger.fatal({ context, important }, x);
else this.logger.error({ context, important }, x);
}
}
@bindThis
public warn(x: string | Error, data?: Record<string, any> | null, important = false): void { // 実行を継続できるが改善すべき状況で使う
public warn(x: string | Error, context?: Record<string, any> | null, important = false): void { // 実行を継続できるが改善すべき状況で使う
if (context === null) context = undefined;
if (x instanceof Error) {
data = data ?? {};
data.error = x;
context = context ?? {};
context.error = x;
this.log('warning', x.toString(), data, important);
this.logger.warn({ context, important }, x.toString());
} else if (typeof x === 'object') {
data = data ?? {};
data.error = data.error ?? x;
context = context ?? {};
context.error = context.error ?? x;
this.log('warning', `${(x as any).message ?? (x as any).name ?? x}`, data, important);
this.logger.warn({ context, important }, `${(x as any).message ?? (x as any).name ?? x}`);
} else {
this.log('warning', `${x}`, data, important);
this.logger.warn({ context, important }, x);
}
}
@bindThis
public succ(message: string, data?: Record<string, any> | null, important = false): void { // 何かに成功した状況で使う
this.log('success', message, data, important);
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, data?: Record<string, any> | null, important = false): void { // デバッグ用に使う(開発者に必要だが利用者に不要な情報)
if (process.env.NODE_ENV !== 'production' || envOption.verbose) {
this.log('debug', message, data, important);
}
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, data?: Record<string, any> | null, important = false): void { // それ以外
this.log('info', message, data, important);
public info(message: string, context?: Record<string, any> | null, important = false): void { // それ以外
if (context === null) context = undefined;
this.logger.info({ context, important }, message);
}
}

7
packages/backend/src/postgres.ts
View File

@@ -80,8 +80,9 @@ import { MiUserMemo } from '@/models/UserMemo.js';
import { MiBubbleGameRecord } from '@/models/BubbleGameRecord.js';
import { Config } from '@/config.js';
import MisskeyLogger from '@/logger.js';
import { bindThis } from '@/decorators.js';
import { envOption } from './env.js';
import MisskeyLogger from '@/logger.js';
export const dbLogger = new MisskeyLogger('db');
@@ -90,6 +91,8 @@ const sqlLogger = dbLogger.createSubLogger('sql', 'gray', false);
class MyCustomLogger implements Logger {
@bindThis
private highlight(sql: string) {
if (envOption.logJson) return sql;
return highlight.highlight(sql, {
language: 'sql', ignoreIllegals: true,
});
@@ -97,7 +100,7 @@ class MyCustomLogger implements Logger {
@bindThis
public logQuery(query: string, parameters?: any[]) {
sqlLogger.info(this.highlight(query).substring(0, 100));
sqlLogger.info(this.highlight(query));
}
@bindThis