server/helpers/logger.ts

   1 // Thanks http://tostring.it/2014/06/23/advanced-logging-with-nodejs/
   2 import * as mkdirp from 'mkdirp'
   3 import * as path from 'path'
   4 import * as winston from 'winston'
   5 import { CONFIG } from '../initializers'
   6
   7 const label = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
   8
   9 // Create the directory if it does not exist
  10 mkdirp.sync(CONFIG.STORAGE.LOG_DIR)
  11
  12 // Use object for better performances (~ O(1))
  13 const excludedKeys = {
  14   level: true,
  15   message: true,
  16   splat: true,
  17   timestamp: true,
  18   label: true
  19 }
  20 function keysExcluder (key, value) {
  21   return excludedKeys[key] === true ? undefined : value
  22 }
  23
  24 const loggerFormat = winston.format.printf((info) => {
  25   let additionalInfos = JSON.stringify(info, keysExcluder, 2)
  26   if (additionalInfos === '{}') additionalInfos = ''
  27   else additionalInfos = ' ' + additionalInfos
  28
  29   return `[${info.label}] ${info.timestamp} ${info.level}: ${info.message}${additionalInfos}`
  30 })
  31
  32 const timestampFormatter = winston.format.timestamp({
  33   format: 'YYYY-MM-dd HH:mm:ss.SSS'
  34 })
  35 const labelFormatter = winston.format.label({
  36   label
  37 })
  38
  39 const logger = new winston.createLogger({
  40   level: CONFIG.LOG.LEVEL,
  41   transports: [
  42     new winston.transports.File({
  43       filename: path.join(CONFIG.STORAGE.LOG_DIR, 'peertube.log'),
  44       handleExceptions: true,
  45       maxsize: 5242880,
  46       maxFiles: 5,
  47       format: winston.format.combine(
  48         timestampFormatter,
  49         labelFormatter,
  50         winston.format.splat(),
  51         winston.format.json()
  52       )
  53     }),
  54     new winston.transports.Console({
  55       handleExceptions: true,
  56       humanReadableUnhandledException: true,
  57       format: winston.format.combine(
  58         timestampFormatter,
  59         winston.format.splat(),
  60         labelFormatter,
  61         winston.format.colorize(),
  62         loggerFormat
  63       )
  64     })
  65   ],
  66   exitOnError: true
  67 })
  68
  69 // ---------------------------------------------------------------------------
  70
  71 export {
  72   timestampFormatter,
  73   labelFormatter,
  74   loggerFormat,
  75   logger
  76 }