X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Flogger.ts;h=5fe3646c55eaf6a23732c75430ba01278c586678;hb=a2f99b54dfdfe489e14714681189cb13c89f60a3;hp=9553f70e80d60986149c7eb8726ea6d2e7c84f31;hpb=610d0be13b3d01f653ef269271dd667a57c85ef2;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts index 9553f70e8..5fe3646c5 100644 --- a/server/helpers/logger.ts +++ b/server/helpers/logger.ts @@ -1,29 +1,36 @@ // Thanks http://tostring.it/2014/06/23/advanced-logging-with-nodejs/ -import { mkdirpSync } from 'fs-extra' -import * as path from 'path' -import * as winston from 'winston' +import { stat } from 'fs-extra' +import { omit } from 'lodash' +import { join } from 'path' +import { format as sqlFormat } from 'sql-formatter' +import { createLogger, format, transports } from 'winston' import { FileTransportOptions } from 'winston/lib/winston/transports' import { CONFIG } from '../initializers/config' -import { omit } from 'lodash' import { LOG_FILENAME } from '../initializers/constants' const label = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT -// Create the directory if it does not exist -// FIXME: use async -mkdirpSync(CONFIG.STORAGE.LOG_DIR) - function getLoggerReplacer () { const seen = new WeakSet() // Thanks: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value#Examples return (key: string, value: any) => { + if (key === 'cert') return 'Replaced by the logger to avoid large log message' + if (typeof value === 'object' && value !== null) { if (seen.has(value)) return seen.add(value) } + if (value instanceof Set) { + return Array.from(value) + } + + if (value instanceof Map) { + return Array.from(value.entries()) + } + if (value instanceof Error) { const error = {} @@ -36,35 +43,48 @@ function getLoggerReplacer () { } } -const consoleLoggerFormat = winston.format.printf(info => { - const obj = omit(info, 'label', 'timestamp', 'level', 'message') +const consoleLoggerFormat = format.printf(info => { + const toOmit = [ 'label', 'timestamp', 'level', 'message', 'sql', 'tags' ] + + const obj = omit(info, ...toOmit) let additionalInfos = JSON.stringify(obj, getLoggerReplacer(), 2) if (additionalInfos === undefined || additionalInfos === '{}') additionalInfos = '' else additionalInfos = ' ' + additionalInfos + if (info.sql) { + if (CONFIG.LOG.PRETTIFY_SQL) { + additionalInfos += '\n' + sqlFormat(info.sql, { + language: 'sql', + indent: ' ' + }) + } else { + additionalInfos += ' - ' + info.sql + } + } + return `[${info.label}] ${info.timestamp} ${info.level}: ${info.message}${additionalInfos}` }) -const jsonLoggerFormat = winston.format.printf(info => { +const jsonLoggerFormat = format.printf(info => { return JSON.stringify(info, getLoggerReplacer()) }) -const timestampFormatter = winston.format.timestamp({ +const timestampFormatter = format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss.SSS' }) const labelFormatter = (suffix?: string) => { - return winston.format.label({ + return format.label({ label: suffix ? `${label} ${suffix}` : label }) } const fileLoggerOptions: FileTransportOptions = { - filename: path.join(CONFIG.STORAGE.LOG_DIR, LOG_FILENAME), + filename: join(CONFIG.STORAGE.LOG_DIR, LOG_FILENAME), handleExceptions: true, - format: winston.format.combine( - winston.format.timestamp(), + format: format.combine( + format.timestamp(), jsonLoggerFormat ) } @@ -77,19 +97,19 @@ if (CONFIG.LOG.ROTATION.ENABLED) { const logger = buildLogger() function buildLogger (labelSuffix?: string) { - return winston.createLogger({ + return createLogger({ level: CONFIG.LOG.LEVEL, - format: winston.format.combine( + format: format.combine( labelFormatter(labelSuffix), - winston.format.splat() + format.splat() ), transports: [ - new winston.transports.File(fileLoggerOptions), - new winston.transports.Console({ + new transports.File(fileLoggerOptions), + new transports.Console({ handleExceptions: true, - format: winston.format.combine( + format: format.combine( timestampFormatter, - winston.format.colorize(), + format.colorize(), consoleLoggerFormat ) }) @@ -99,10 +119,9 @@ function buildLogger (labelSuffix?: string) { } function bunyanLogFactory (level: string) { - return function () { + return function (...params: any[]) { let meta = null - let args: any[] = [] - args.concat(arguments) + let args = [].concat(params) if (arguments[0] instanceof Error) { meta = arguments[0].toString() @@ -119,6 +138,7 @@ function bunyanLogFactory (level: string) { } const bunyanLogger = { + level: () => { }, trace: bunyanLogFactory('debug'), debug: bunyanLogFactory('debug'), info: bunyanLogFactory('info'), @@ -126,14 +146,46 @@ const bunyanLogger = { error: bunyanLogFactory('error'), fatal: bunyanLogFactory('error') } + +type LoggerTagsFn = (...tags: string[]) => { tags: string[] } +function loggerTagsFactory (...defaultTags: string[]): LoggerTagsFn { + return (...tags: string[]) => { + return { tags: defaultTags.concat(tags) } + } +} + +async function mtimeSortFilesDesc (files: string[], basePath: string) { + const promises = [] + const out: { file: string, mtime: number }[] = [] + + for (const file of files) { + const p = stat(basePath + '/' + file) + .then(stats => { + if (stats.isFile()) out.push({ file, mtime: stats.mtime.getTime() }) + }) + + promises.push(p) + } + + await Promise.all(promises) + + out.sort((a, b) => b.mtime - a.mtime) + + return out +} + // --------------------------------------------------------------------------- export { + LoggerTagsFn, + buildLogger, timestampFormatter, labelFormatter, consoleLoggerFormat, jsonLoggerFormat, + mtimeSortFilesDesc, logger, + loggerTagsFactory, bunyanLogger }