Feature/logrotation (#1881)

[github/Chocobozzz/PeerTube.git] / server / helpers / logger.ts

diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts
index a4e5b58a4e62c4985e218f916faffc082288370d..8603dd76127afe0a7b253db9460e1d6cbf334b93 100644 (file)
--- a/server/helpers/logger.ts
+++ b/server/helpers/logger.ts
@@ -1,70 +1,78 @@
 // 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'
 
 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 loggerReplacer (key: string, value: any) {
+  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, loggerReplacer, 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, loggerReplacer)
 })
 
 const timestampFormatter = winston.format.timestamp({
-  format: 'YYYY-MM-dd HH:mm:ss.SSS'
+  format: 'YYYY-MM-DD HH:mm:ss.SSS'
 })
 const labelFormatter = winston.format.label({
   label
 })
 
-const logger = new winston.createLogger({
+const fileLoggerOptions: FileTransportOptions = {
+
+  filename: path.join(CONFIG.STORAGE.LOG_DIR, 'peertube.log'),
+  handleExceptions: true,
+  format: winston.format.combine(
+    winston.format.timestamp(),
+    jsonLoggerFormat
+  )
+}
+
+if (CONFIG.LOG.ROTATION) {
+  fileLoggerOptions.maxsize = 1024 * 1024 * 12
+  fileLoggerOptions.maxFiles = 20
+}
+
+const logger = winston.createLogger({
   level: CONFIG.LOG.LEVEL,
+  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: 5242880,
-      maxFiles: 5,
-      format: winston.format.combine(
-        timestampFormatter,
-        labelFormatter,
-        winston.format.splat(),
-        jsonLoggerFormat
-      )
-    }),
+    new winston.transports.File(fileLoggerOptions),
     new winston.transports.Console({
       handleExceptions: true,
-      humanReadableUnhandledException: true,
       format: winston.format.combine(
         timestampFormatter,
-        winston.format.splat(),
-        labelFormatter,
         winston.format.colorize(),
         consoleLoggerFormat
       )
@@ -73,11 +81,40 @@ const logger = new winston.createLogger({
   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 {
   timestampFormatter,
   labelFormatter,
   consoleLoggerFormat,
-  logger
+  jsonLoggerFormat,
+  logger,
+  bunyanLogger
 }