X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Flogger.ts;h=6649db40f4a1eef3651976027ff23b39a5874384;hb=bd09dfaf8dcb0ca4cd5dac9f13e3117486f3bcce;hp=20c3c3edbaa111bb5ef304a98ae7781fb5648ebd;hpb=171efc48e67498406feb6d7873b3482b41505515;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts
index 20c3c3edb..6649db40f 100644
--- a/server/helpers/logger.ts
+++ b/server/helpers/logger.ts
@@ -1,58 +1,18 @@
-// Thanks http://tostring.it/2014/06/23/advanced-logging-with-nodejs/
-import { mkdirpSync, stat } from 'fs-extra'
-import { omit } from 'lodash'
-import * as path from 'path'
+import { stat } from 'fs-extra'
+import { join } from 'path'
 import { format as sqlFormat } from 'sql-formatter'
-import * as winston from 'winston'
+import { createLogger, format, transports } from 'winston'
 import { FileTransportOptions } from 'winston/lib/winston/transports'
+import { context } from '@opentelemetry/api'
+import { getSpanContext } from '@opentelemetry/api/build/src/trace/context-utils'
+import { omit } from '@shared/core-utils'
 import { CONFIG } from '../initializers/config'
 import { LOG_FILENAME } from '../initializers/constants'
 
 const label = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
 
-// Create the directory if it does not exist
-// FIXME: use async
-mkdirpSync(CONFIG.STORAGE.LOG_DIR)
-
-function getLoggerReplacer () {
-  const seen = new WeakSet()
-
-  // Thanks: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value#Examples
-  return (key: string, value: any) => {
-    if (key === 'cert') return 'Replaced by the logger to avoid large log message'
-
-    if (typeof value === 'object' && value !== null) {
-      if (seen.has(value)) return
-
-      seen.add(value)
-    }
-
-    if (value instanceof Set) {
-      return Array.from(value)
-    }
-
-    if (value instanceof Map) {
-      return Array.from(value.entries())
-    }
-
-    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 => {
-  const toOmit = [ 'label', 'timestamp', 'level', 'message', 'sql', 'tags' ]
-
-  const obj = omit(info, ...toOmit)
-
-  let additionalInfos = JSON.stringify(obj, getLoggerReplacer(), 2)
+const consoleLoggerFormat = format.printf(info => {
+  let additionalInfos = JSON.stringify(getAdditionalInfo(info), removeCyclicValues(), 2)
 
   if (additionalInfos === undefined || additionalInfos === '{}') additionalInfos = ''
   else additionalInfos = ' ' + additionalInfos
@@ -61,7 +21,7 @@ const consoleLoggerFormat = winston.format.printf(info => {
     if (CONFIG.LOG.PRETTIFY_SQL) {
       additionalInfos += '\n' + sqlFormat(info.sql, {
         language: 'sql',
-        indent: '  '
+        tabWidth: 2
       })
     } else {
       additionalInfos += ' - ' + info.sql
@@ -71,24 +31,24 @@ const consoleLoggerFormat = winston.format.printf(info => {
   return `[${info.label}] ${info.timestamp} ${info.level}: ${info.message}${additionalInfos}`
 })
 
-const jsonLoggerFormat = winston.format.printf(info => {
-  return JSON.stringify(info, getLoggerReplacer())
+const jsonLoggerFormat = format.printf(info => {
+  return JSON.stringify(info, removeCyclicValues())
 })
 
-const timestampFormatter = winston.format.timestamp({
+const timestampFormatter = format.timestamp({
   format: 'YYYY-MM-DD HH:mm:ss.SSS'
 })
 const labelFormatter = (suffix?: string) => {
-  return winston.format.label({
+  return format.label({
     label: suffix ? `${label} ${suffix}` : label
   })
 }
 
 const fileLoggerOptions: FileTransportOptions = {
-  filename: path.join(CONFIG.STORAGE.LOG_DIR, LOG_FILENAME),
+  filename: join(CONFIG.STORAGE.LOG_DIR, LOG_FILENAME),
   handleExceptions: true,
-  format: winston.format.combine(
-    winston.format.timestamp(),
+  format: format.combine(
+    format.timestamp(),
     jsonLoggerFormat
   )
 }
@@ -98,22 +58,25 @@ if (CONFIG.LOG.ROTATION.ENABLED) {
   fileLoggerOptions.maxFiles = CONFIG.LOG.ROTATION.MAX_FILES
 }
 
-const logger = buildLogger()
-
 function buildLogger (labelSuffix?: string) {
-  return winston.createLogger({
+  return createLogger({
     level: CONFIG.LOG.LEVEL,
-    format: winston.format.combine(
+    defaultMeta: {
+      get traceId () { return getSpanContext(context.active())?.traceId },
+      get spanId () { return getSpanContext(context.active())?.spanId },
+      get traceFlags () { return getSpanContext(context.active())?.traceFlags }
+    },
+    format: format.combine(
       labelFormatter(labelSuffix),
-      winston.format.splat()
+      format.splat()
     ),
     transports: [
-      new winston.transports.File(fileLoggerOptions),
-      new winston.transports.Console({
+      new transports.File(fileLoggerOptions),
+      new transports.Console({
         handleExceptions: true,
-        format: winston.format.combine(
+        format: format.combine(
           timestampFormatter,
-          winston.format.colorize(),
+          format.colorize(),
           consoleLoggerFormat
         )
       })
@@ -122,11 +85,14 @@ function buildLogger (labelSuffix?: string) {
   })
 }
 
+const logger = buildLogger()
+
+// ---------------------------------------------------------------------------
+
 function bunyanLogFactory (level: string) {
-  return function () {
+  return function (...params: any[]) {
     let meta = null
-    let args: any[] = []
-    args.concat(arguments)
+    let args = [].concat(params)
 
     if (arguments[0] instanceof Error) {
       meta = arguments[0].toString()
@@ -143,14 +109,18 @@ function bunyanLogFactory (level: string) {
 }
 
 const bunyanLogger = {
+  level: () => { },
   trace: bunyanLogFactory('debug'),
   debug: bunyanLogFactory('debug'),
+  verbose: bunyanLogFactory('debug'),
   info: bunyanLogFactory('info'),
   warn: bunyanLogFactory('warn'),
   error: bunyanLogFactory('error'),
   fatal: bunyanLogFactory('error')
 }
 
+// ---------------------------------------------------------------------------
+
 type LoggerTagsFn = (...tags: string[]) => { tags: string[] }
 function loggerTagsFactory (...defaultTags: string[]): LoggerTagsFn {
   return (...tags: string[]) => {
@@ -158,6 +128,8 @@ function loggerTagsFactory (...defaultTags: string[]): LoggerTagsFn {
   }
 }
 
+// ---------------------------------------------------------------------------
+
 async function mtimeSortFilesDesc (files: string[], basePath: string) {
   const promises = []
   const out: { file: string, mtime: number }[] = []
@@ -193,3 +165,44 @@ export {
   loggerTagsFactory,
   bunyanLogger
 }
+
+// ---------------------------------------------------------------------------
+
+function removeCyclicValues () {
+  const seen = new WeakSet()
+
+  // Thanks: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value#Examples
+  return (key: string, value: any) => {
+    if (key === 'cert') return 'Replaced by the logger to avoid large log message'
+
+    if (typeof value === 'object' && value !== null) {
+      if (seen.has(value)) return
+
+      seen.add(value)
+    }
+
+    if (value instanceof Set) {
+      return Array.from(value)
+    }
+
+    if (value instanceof Map) {
+      return Array.from(value.entries())
+    }
+
+    if (value instanceof Error) {
+      const error = {}
+
+      Object.getOwnPropertyNames(value).forEach(key => { error[key] = value[key] })
+
+      return error
+    }
+
+    return value
+  }
+}
+
+function getAdditionalInfo (info: any) {
+  const toOmit = [ 'label', 'timestamp', 'level', 'message', 'sql', 'tags' ]
+
+  return omit(info, toOmit)
+}