1
0
Fork 0
peertube/server/helpers/logger.ts

132 lines
3.5 KiB
TypeScript
Raw Normal View History

// Thanks http://tostring.it/2014/06/23/advanced-logging-with-nodejs/
import { mkdirpSync } from 'fs-extra'
2017-06-05 15:53:49 -04:00
import * as path from 'path'
import * as winston from 'winston'
import { FileTransportOptions } from 'winston/lib/winston/transports'
2019-04-11 05:33:44 -04:00
import { CONFIG } from '../initializers/config'
2019-04-10 09:26:33 -04:00
import { omit } from 'lodash'
2019-12-11 08:14:01 -05:00
import { LOG_FILENAME } from '@server/initializers/constants'
2015-06-09 11:41:40 -04:00
2017-05-15 16:22:03 -04:00
const label = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
// Create the directory if it does not exist
2019-04-10 09:26:33 -04:00
// FIXME: use async
mkdirpSync(CONFIG.STORAGE.LOG_DIR)
2019-11-05 05:08:51 -05:00
function getLoggerReplacer () {
const seen = new WeakSet()
2018-07-30 04:59:31 -04:00
2019-11-05 05:08:51 -05:00
// 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
2018-03-26 09:54:13 -04:00
2019-11-05 05:08:51 -05:00
seen.add(value)
}
if (value instanceof Error) {
const error = {}
Object.getOwnPropertyNames(value).forEach(key => error[ key ] = value[ key ])
2018-03-26 09:54:13 -04:00
2019-11-05 05:08:51 -05:00
return error
}
return value
}
2018-01-19 07:58:13 -05:00
}
const consoleLoggerFormat = winston.format.printf(info => {
2019-04-10 09:26:33 -04:00
const obj = omit(info, 'label', 'timestamp', 'level', 'message')
2019-11-05 05:08:51 -05:00
let additionalInfos = JSON.stringify(obj, getLoggerReplacer(), 2)
2019-04-10 09:26:33 -04:00
2018-07-30 04:59:31 -04:00
if (additionalInfos === undefined || additionalInfos === '{}') additionalInfos = ''
2018-01-19 08:47:03 -05:00
else additionalInfos = ' ' + additionalInfos
2018-01-19 07:58:13 -05:00
2018-01-19 08:47:03 -05:00
return `[${info.label}] ${info.timestamp} ${info.level}: ${info.message}${additionalInfos}`
2018-01-19 07:58:13 -05:00
})
2018-07-30 04:59:31 -04:00
const jsonLoggerFormat = winston.format.printf(info => {
2019-11-05 05:08:51 -05:00
return JSON.stringify(info, getLoggerReplacer())
})
2018-01-19 07:58:13 -05:00
const timestampFormatter = winston.format.timestamp({
2018-03-08 12:16:15 -05:00
format: 'YYYY-MM-DD HH:mm:ss.SSS'
2018-01-19 07:58:13 -05:00
})
const labelFormatter = winston.format.label({
label
})
const fileLoggerOptions: FileTransportOptions = {
2019-12-11 08:14:01 -05:00
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
}
2018-06-26 11:52:14 -04:00
const logger = winston.createLogger({
2018-01-19 07:58:13 -05:00
level: CONFIG.LOG.LEVEL,
2018-07-30 04:59:31 -04:00
format: winston.format.combine(
labelFormatter,
winston.format.splat()
),
transports: [
new winston.transports.File(fileLoggerOptions),
new winston.transports.Console({
2018-02-21 10:44:18 -05:00
handleExceptions: true,
2018-01-19 07:58:13 -05:00
format: winston.format.combine(
timestampFormatter,
winston.format.colorize(),
consoleLoggerFormat
2018-01-19 07:58:13 -05:00
)
})
],
exitOnError: true
})
2015-06-09 11:41:40 -04:00
2018-03-22 06:32:43 -04:00
function bunyanLogFactory (level: string) {
return function () {
let meta = null
let args: any[] = []
args.concat(arguments)
2018-03-22 06:32:43 -04:00
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')
}
// ---------------------------------------------------------------------------
2016-01-31 05:23:52 -05:00
2018-01-19 07:58:13 -05:00
export {
timestampFormatter,
labelFormatter,
consoleLoggerFormat,
2018-07-31 08:02:47 -04:00
jsonLoggerFormat,
2018-03-22 06:32:43 -04:00
logger,
bunyanLogger
2018-01-19 07:58:13 -05:00
}