PeerTube/server/helpers/logger.ts

142 lines
3.8 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 21:53:49 +02:00
import * as path from 'path'
import * as winston from 'winston'
import { FileTransportOptions } from 'winston/lib/winston/transports'
2019-04-11 11:33:44 +02:00
import { CONFIG } from '../initializers/config'
2019-04-10 15:26:33 +02:00
import { omit } from 'lodash'
import { LOG_FILENAME } from '../initializers/constants'
2015-06-09 17:41:40 +02:00
2017-05-15 22:22:03 +02:00
const label = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
// Create the directory if it does not exist
2019-04-10 15:26:33 +02:00
// FIXME: use async
mkdirpSync(CONFIG.STORAGE.LOG_DIR)
2019-11-05 11:08:51 +01:00
function getLoggerReplacer () {
const seen = new WeakSet()
2018-07-30 10:59:31 +02:00
2019-11-05 11:08:51 +01:00
// Thanks: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value#Examples
return (key: string, value: any) => {
2020-11-25 14:43:18 +01:00
if (key === 'cert') return 'Replaced by the logger to avoid large log message'
2019-11-05 11:08:51 +01:00
if (typeof value === 'object' && value !== null) {
if (seen.has(value)) return
2018-03-26 15:54:13 +02:00
2019-11-05 11:08:51 +01:00
seen.add(value)
}
if (value instanceof Error) {
const error = {}
2020-01-31 16:56:52 +01:00
Object.getOwnPropertyNames(value).forEach(key => { error[key] = value[key] })
2018-03-26 15:54:13 +02:00
2019-11-05 11:08:51 +01:00
return error
}
return value
}
2018-01-19 13:58:13 +01:00
}
const consoleLoggerFormat = winston.format.printf(info => {
2019-04-10 15:26:33 +02:00
const obj = omit(info, 'label', 'timestamp', 'level', 'message')
2019-11-05 11:08:51 +01:00
let additionalInfos = JSON.stringify(obj, getLoggerReplacer(), 2)
2019-04-10 15:26:33 +02:00
2018-07-30 10:59:31 +02:00
if (additionalInfos === undefined || additionalInfos === '{}') additionalInfos = ''
2018-01-19 14:47:03 +01:00
else additionalInfos = ' ' + additionalInfos
2018-01-19 13:58:13 +01:00
2018-01-19 14:47:03 +01:00
return `[${info.label}] ${info.timestamp} ${info.level}: ${info.message}${additionalInfos}`
2018-01-19 13:58:13 +01:00
})
2018-07-30 10:59:31 +02:00
const jsonLoggerFormat = winston.format.printf(info => {
2019-11-05 11:08:51 +01:00
return JSON.stringify(info, getLoggerReplacer())
})
2018-01-19 13:58:13 +01:00
const timestampFormatter = winston.format.timestamp({
2018-03-08 18:16:15 +01:00
format: 'YYYY-MM-DD HH:mm:ss.SSS'
2018-01-19 13:58:13 +01:00
})
2020-04-09 09:57:32 +02:00
const labelFormatter = (suffix?: string) => {
return winston.format.label({
label: suffix ? `${label} ${suffix}` : label
})
}
2018-01-19 13:58:13 +01:00
const fileLoggerOptions: FileTransportOptions = {
2019-12-11 14:14:01 +01: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
}
2020-04-09 09:57:32 +02:00
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
})
}
2015-06-09 17:41:40 +02:00
2018-03-22 11:32:43 +01:00
function bunyanLogFactory (level: string) {
return function () {
let meta = null
let args: any[] = []
args.concat(arguments)
2018-03-22 11:32:43 +01:00
2020-01-31 16:56:52 +01:00
if (arguments[0] instanceof Error) {
meta = arguments[0].toString()
2018-03-22 11:32:43 +01:00
args = Array.prototype.slice.call(arguments, 1)
args.push(meta)
2020-01-31 16:56:52 +01:00
} else if (typeof (args[0]) !== 'string') {
meta = arguments[0]
2018-03-22 11:32:43 +01:00
args = Array.prototype.slice.call(arguments, 1)
args.push(meta)
}
2020-01-31 16:56:52 +01:00
logger[level].apply(logger, args)
2018-03-22 11:32:43 +01:00
}
}
2020-01-31 16:56:52 +01:00
2018-03-22 11:32:43 +01:00
const bunyanLogger = {
trace: bunyanLogFactory('debug'),
debug: bunyanLogFactory('debug'),
info: bunyanLogFactory('info'),
warn: bunyanLogFactory('warn'),
error: bunyanLogFactory('error'),
fatal: bunyanLogFactory('error')
}
// ---------------------------------------------------------------------------
2016-01-31 11:23:52 +01:00
2018-01-19 13:58:13 +01:00
export {
2020-04-09 09:57:32 +02:00
buildLogger,
2018-01-19 13:58:13 +01:00
timestampFormatter,
labelFormatter,
consoleLoggerFormat,
2018-07-31 14:02:47 +02:00
jsonLoggerFormat,
2018-03-22 11:32:43 +01:00
logger,
bunyanLogger
2018-01-19 13:58:13 +01:00
}