X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Flogger.ts;h=20c3c3edbaa111bb5ef304a98ae7781fb5648ebd;hb=fbd67e7f386504e50f2504cb6386700a58906f16;hp=3954176121cf2458a37a85e2fd5a639f0b85e2ab;hpb=2f6b5e2d6ebcac88d9005ea2654ffa77907d5db2;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts index 395417612..20c3c3edb 100644 --- a/server/helpers/logger.ts +++ b/server/helpers/logger.ts @@ -1,11 +1,12 @@ // Thanks http://tostring.it/2014/06/23/advanced-logging-with-nodejs/ -import { mkdirpSync } from 'fs-extra' +import { mkdirpSync, stat } from 'fs-extra' +import { omit } from 'lodash' import * as path from 'path' +import { format as sqlFormat } from 'sql-formatter' import * as winston from 'winston' import { FileTransportOptions } from 'winston/lib/winston/transports' import { CONFIG } from '../initializers/config' -import { omit } from 'lodash' -import { LOG_FILENAME } from '@server/initializers/constants' +import { LOG_FILENAME } from '../initializers/constants' const label = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT @@ -18,16 +19,26 @@ function getLoggerReplacer () { // 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 = {} - Object.getOwnPropertyNames(value).forEach(key => error[ key ] = value[ key ]) + Object.getOwnPropertyNames(value).forEach(key => { error[key] = value[key] }) return error } @@ -37,13 +48,26 @@ function getLoggerReplacer () { } const consoleLoggerFormat = winston.format.printf(info => { - const obj = omit(info, 'label', 'timestamp', 'level', 'message') + 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}` }) @@ -54,9 +78,11 @@ const jsonLoggerFormat = winston.format.printf(info => { const timestampFormatter = winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss.SSS' }) -const labelFormatter = winston.format.label({ - label -}) +const labelFormatter = (suffix?: string) => { + return winston.format.label({ + label: suffix ? `${label} ${suffix}` : label + }) +} const fileLoggerOptions: FileTransportOptions = { filename: path.join(CONFIG.STORAGE.LOG_DIR, LOG_FILENAME), @@ -72,25 +98,29 @@ if (CONFIG.LOG.ROTATION.ENABLED) { fileLoggerOptions.maxFiles = CONFIG.LOG.ROTATION.MAX_FILES } -const logger = winston.createLogger({ - level: CONFIG.LOG.LEVEL, - format: winston.format.combine( - labelFormatter, - winston.format.splat() - ), - transports: [ - new winston.transports.File(fileLoggerOptions), - new winston.transports.Console({ - handleExceptions: true, - format: winston.format.combine( - timestampFormatter, - winston.format.colorize(), - consoleLoggerFormat - ) - }) - ], - exitOnError: true -}) +const logger = buildLogger() + +function buildLogger (labelSuffix?: string) { + return winston.createLogger({ + level: CONFIG.LOG.LEVEL, + format: winston.format.combine( + labelFormatter(labelSuffix), + winston.format.splat() + ), + transports: [ + new winston.transports.File(fileLoggerOptions), + new winston.transports.Console({ + handleExceptions: true, + format: winston.format.combine( + timestampFormatter, + winston.format.colorize(), + consoleLoggerFormat + ) + }) + ], + exitOnError: true + }) +} function bunyanLogFactory (level: string) { return function () { @@ -98,19 +128,20 @@ function bunyanLogFactory (level: string) { let args: any[] = [] args.concat(arguments) - if (arguments[ 0 ] instanceof Error) { - meta = arguments[ 0 ].toString() + if (arguments[0] instanceof Error) { + meta = arguments[0].toString() args = Array.prototype.slice.call(arguments, 1) args.push(meta) - } else if (typeof (args[ 0 ]) !== 'string') { - meta = arguments[ 0 ] + } else if (typeof (args[0]) !== 'string') { + meta = arguments[0] args = Array.prototype.slice.call(arguments, 1) args.push(meta) } - logger[ level ].apply(logger, args) + logger[level].apply(logger, args) } } + const bunyanLogger = { trace: bunyanLogFactory('debug'), debug: bunyanLogFactory('debug'), @@ -119,13 +150,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 }