X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Flogger.ts;h=9553f70e80d60986149c7eb8726ea6d2e7c84f31;hb=444c0a0e017824fb4ce526281a22c4abe0a13c50;hp=7d1d72f29d8b1d1fae4b858304777ecf1b11a152;hpb=276d03ed1a469fd4e3579f92392b6f9a1567d1ca;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts index 7d1d72f29..9553f70e8 100644 --- a/server/helpers/logger.ts +++ b/server/helpers/logger.ts @@ -1,83 +1,139 @@ // Thanks http://tostring.it/2014/06/23/advanced-logging-with-nodejs/ -import * as mkdirp from 'mkdirp' +import { mkdirpSync } from 'fs-extra' import * as path from 'path' import * as winston from 'winston' -import { CONFIG } from '../initializers' +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 -mkdirp.sync(CONFIG.STORAGE.LOG_DIR) - -// Use object for better performances (~ O(1)) -const excludedKeys = { - level: true, - message: true, - splat: true, - timestamp: true, - label: true -} -function keysExcluder (key, value) { - return excludedKeys[key] === true ? undefined : value +// 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 (typeof value === 'object' && value !== null) { + if (seen.has(value)) return + + seen.add(value) + } + + if (value instanceof Error) { + const error = {} + + Object.getOwnPropertyNames(value).forEach(key => { error[key] = value[key] }) + + return error + } + + return value + } } const consoleLoggerFormat = winston.format.printf(info => { - let additionalInfos = JSON.stringify(info, keysExcluder, 2) - if (additionalInfos === '{}') additionalInfos = '' + const obj = omit(info, 'label', 'timestamp', 'level', 'message') + + let additionalInfos = JSON.stringify(obj, getLoggerReplacer(), 2) + + if (additionalInfos === undefined || additionalInfos === '{}') additionalInfos = '' else additionalInfos = ' ' + additionalInfos - if (info.message && info.message.stack !== undefined) info.message = info.message.stack return `[${info.label}] ${info.timestamp} ${info.level}: ${info.message}${additionalInfos}` }) const jsonLoggerFormat = winston.format.printf(info => { - if (info.message && info.message.stack !== undefined) info.message = info.message.stack - - return JSON.stringify(info) + return JSON.stringify(info, getLoggerReplacer()) }) const timestampFormatter = winston.format.timestamp({ - format: 'YYYY-MM-dd HH:mm:ss.SSS' -}) -const labelFormatter = winston.format.label({ - label + format: 'YYYY-MM-DD HH:mm:ss.SSS' }) +const labelFormatter = (suffix?: string) => { + return winston.format.label({ + label: suffix ? `${label} ${suffix}` : label + }) +} -const logger = new winston.createLogger({ - level: CONFIG.LOG.LEVEL, - transports: [ - new winston.transports.File({ - filename: path.join(CONFIG.STORAGE.LOG_DIR, 'peertube.log'), - handleExceptions: true, - maxsize: 5242880, - maxFiles: 5, - format: winston.format.combine( - timestampFormatter, - labelFormatter, - winston.format.splat(), - jsonLoggerFormat - ) - }), - new winston.transports.Console({ - handleExcegiptions: true, - humanReadableUnhandledException: true, - format: winston.format.combine( - timestampFormatter, - winston.format.splat(), - labelFormatter, - winston.format.colorize(), - consoleLoggerFormat - ) - }) - ], - exitOnError: true -}) +const fileLoggerOptions: FileTransportOptions = { + filename: path.join(CONFIG.STORAGE.LOG_DIR, LOG_FILENAME), + handleExceptions: true, + format: winston.format.combine( + winston.format.timestamp(), + jsonLoggerFormat + ) +} + +if (CONFIG.LOG.ROTATION.ENABLED) { + fileLoggerOptions.maxsize = CONFIG.LOG.ROTATION.MAX_FILE_SIZE + fileLoggerOptions.maxFiles = CONFIG.LOG.ROTATION.MAX_FILES +} + +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 () { + let meta = null + let args: any[] = [] + args.concat(arguments) + + 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] + args = Array.prototype.slice.call(arguments, 1) + args.push(meta) + } + logger[level].apply(logger, args) + } +} + +const bunyanLogger = { + trace: bunyanLogFactory('debug'), + debug: bunyanLogFactory('debug'), + info: bunyanLogFactory('info'), + warn: bunyanLogFactory('warn'), + error: bunyanLogFactory('error'), + fatal: bunyanLogFactory('error') +} // --------------------------------------------------------------------------- export { + buildLogger, timestampFormatter, labelFormatter, consoleLoggerFormat, - logger + jsonLoggerFormat, + logger, + bunyanLogger }