84 lines
2 KiB
TypeScript
84 lines
2 KiB
TypeScript
// Copyright 2021 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
import * as pino from 'pino';
|
|
import { redactAll } from '../util/privacy';
|
|
import { missingCaseError } from '../util/missingCaseError';
|
|
import { reallyJsonStringify } from '../util/reallyJsonStringify';
|
|
|
|
// These match [Pino's recommendations][0].
|
|
// [0]: https://getpino.io/#/docs/api?id=loggerlevels-object
|
|
export enum LogLevel {
|
|
Fatal = 60,
|
|
Error = 50,
|
|
Warn = 40,
|
|
Info = 30,
|
|
Debug = 20,
|
|
Trace = 10,
|
|
}
|
|
|
|
// These match [Pino's core fields][1].
|
|
// [1]: https://getpino.io/#/?id=usage
|
|
export type LogEntryType = Readonly<{
|
|
level: LogLevel;
|
|
msg: string;
|
|
time: string;
|
|
}>;
|
|
|
|
// The code below is performance sensitive since it runs for > 100k log entries
|
|
// whenever we want to send the debug log. We can't use `zod` because it clones
|
|
// the data on successful parse and ruins the performance.
|
|
export const isLogEntry = (data: unknown): data is LogEntryType => {
|
|
if (data === null || typeof data !== 'object') {
|
|
return false;
|
|
}
|
|
|
|
const { level, msg, time } = data as Partial<LogEntryType>;
|
|
|
|
if (typeof level !== 'number') {
|
|
return false;
|
|
}
|
|
|
|
if (!LogLevel[level]) {
|
|
return false;
|
|
}
|
|
|
|
if (typeof msg !== 'string') {
|
|
return false;
|
|
}
|
|
|
|
if (typeof time !== 'string') {
|
|
return false;
|
|
}
|
|
|
|
return !Number.isNaN(new Date(time).getTime());
|
|
};
|
|
|
|
export function getLogLevelString(value: LogLevel): pino.Level {
|
|
switch (value) {
|
|
case LogLevel.Fatal:
|
|
return 'fatal';
|
|
case LogLevel.Error:
|
|
return 'error';
|
|
case LogLevel.Warn:
|
|
return 'warn';
|
|
case LogLevel.Info:
|
|
return 'info';
|
|
case LogLevel.Debug:
|
|
return 'debug';
|
|
case LogLevel.Trace:
|
|
return 'trace';
|
|
default:
|
|
throw missingCaseError(value);
|
|
}
|
|
}
|
|
|
|
export function cleanArgs(args: ReadonlyArray<unknown>): string {
|
|
return redactAll(
|
|
args
|
|
.map(item =>
|
|
typeof item === 'string' ? item : reallyJsonStringify(item)
|
|
)
|
|
.join(' ')
|
|
);
|
|
}
|