X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Flogger.ts;h=9553f70e80d60986149c7eb8726ea6d2e7c84f31;hb=444c0a0e017824fb4ce526281a22c4abe0a13c50;hp=f8a1427185454ccb1f31385de6cc4aff2da547c3;hpb=fd8710b897a67518d3a61c319e54b6a65ba443ef;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts index f8a142718..9553f70e8 100644 --- a/server/helpers/logger.ts +++ b/server/helpers/logger.ts @@ -2,8 +2,10 @@ 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 @@ -11,22 +13,33 @@ const label = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT // FIXME: use async mkdirpSync(CONFIG.STORAGE.LOG_DIR) -function loggerReplacer (key: string, value: any) { - if (value instanceof Error) { - const error = {} +function getLoggerReplacer () { + const seen = new WeakSet() - Object.getOwnPropertyNames(value).forEach(key => error[ key ] = value[ key ]) + // 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 - return error - } + seen.add(value) + } + + if (value instanceof Error) { + const error = {} + + Object.getOwnPropertyNames(value).forEach(key => { error[key] = value[key] }) - return value + return error + } + + return value + } } const consoleLoggerFormat = winston.format.printf(info => { const obj = omit(info, 'label', 'timestamp', 'level', 'message') - let additionalInfos = JSON.stringify(obj, loggerReplacer, 2) + let additionalInfos = JSON.stringify(obj, getLoggerReplacer(), 2) if (additionalInfos === undefined || additionalInfos === '{}') additionalInfos = '' else additionalInfos = ' ' + additionalInfos @@ -35,44 +48,55 @@ const consoleLoggerFormat = winston.format.printf(info => { }) const jsonLoggerFormat = winston.format.printf(info => { - return JSON.stringify(info, loggerReplacer) + return JSON.stringify(info, getLoggerReplacer()) }) 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 logger = winston.createLogger({ - level: CONFIG.LOG.LEVEL, +const fileLoggerOptions: FileTransportOptions = { + filename: path.join(CONFIG.STORAGE.LOG_DIR, LOG_FILENAME), + handleExceptions: true, format: winston.format.combine( - labelFormatter, - winston.format.splat() - ), - transports: [ - new winston.transports.File({ - filename: path.join(CONFIG.STORAGE.LOG_DIR, 'peertube.log'), - handleExceptions: true, - maxsize: 1024 * 1024 * 12, - maxFiles: 20, - format: winston.format.combine( - winston.format.timestamp(), - jsonLoggerFormat - ) - }), - new winston.transports.Console({ - handleExceptions: true, - format: winston.format.combine( - timestampFormatter, - winston.format.colorize(), - consoleLoggerFormat - ) - }) - ], - exitOnError: true -}) + 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 () { @@ -80,19 +104,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'), @@ -104,6 +129,7 @@ const bunyanLogger = { // --------------------------------------------------------------------------- export { + buildLogger, timestampFormatter, labelFormatter, consoleLoggerFormat,