Add ability to configure log level

6 files changed, 59 insertions, 14 deletions

diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts
index 77547c528..65f18d644 100644
--- a/server/helpers/core-utils.ts
+++ b/server/helpers/core-utils.ts
@@ -50,6 +50,8 @@ function root () {
 
 // Thanks: https://stackoverflow.com/a/12034334
 function escapeHTML (stringParam) {
+  if (!stringParam) return ''
+
   const entityMap = {
     '&': '&',
     '<': '&lt;',
diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts
index 2676133db..6a02f680a 100644
--- a/server/helpers/logger.ts
+++ b/server/helpers/logger.ts
@@ -9,26 +9,57 @@ const label = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
 // Create the directory if it does not exist
 mkdirp.sync(CONFIG.STORAGE.LOG_DIR)
 
-const logger = new winston.Logger({
+// 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
+}
+
+const loggerFormat = winston.format.printf((info) => {
+  let additionalInfos = JSON.stringify(info, keysExcluder, 2)
+  if (additionalInfos === '{}') additionalInfos = ''
+
+  return `[${info.label}] ${info.timestamp} ${info.level}: ${info.message} ${additionalInfos}`
+})
+
+const timestampFormatter = winston.format.timestamp({
+  format: 'YYYY-MM-dd HH:mm:ss.SSS'
+})
+const labelFormatter = winston.format.label({
+  label
+})
+
+const logger = new winston.createLogger({
+  level: CONFIG.LOG.LEVEL,
   transports: [
     new winston.transports.File({
-      level: 'debug',
-      filename: path.join(CONFIG.STORAGE.LOG_DIR, 'all-logs.log'),
+      filename: path.join(CONFIG.STORAGE.LOG_DIR, 'peertube.log'),
       handleExceptions: true,
-      json: true,
       maxsize: 5242880,
       maxFiles: 5,
-      colorize: false,
-      prettyPrint: true
+      format: winston.format.combine(
+        timestampFormatter,
+        labelFormatter,
+        winston.format.splat(),
+        winston.format.json()
+      )
     }),
     new winston.transports.Console({
-      level: 'debug',
-      label: label,
       handleExceptions: true,
       humanReadableUnhandledException: true,
-      json: false,
-      colorize: true,
-      prettyPrint: true
+      format: winston.format.combine(
+        timestampFormatter,
+        winston.format.splat(),
+        labelFormatter,
+        winston.format.colorize(),
+        loggerFormat
+      )
     })
   ],
   exitOnError: true
@@ -36,4 +67,9 @@ const logger = new winston.Logger({
 
 // ---------------------------------------------------------------------------
 
-export { logger }
+export {
+  timestampFormatter,
+  labelFormatter,
+  loggerFormat,
+  logger
+}
diff --git a/server/initializers/checker.ts b/server/initializers/checker.ts
index 7cfbc123d..35fab244c 100644
--- a/server/initializers/checker.ts
+++ b/server/initializers/checker.ts
@@ -21,7 +21,7 @@ function checkMissedConfig () {
   const required = [ 'listen.port',
     'webserver.https', 'webserver.hostname', 'webserver.port',
     'database.hostname', 'database.port', 'database.suffix', 'database.username', 'database.password',
-    'storage.videos', 'storage.logs', 'storage.thumbnails', 'storage.previews', 'storage.torrents', 'storage.cache',
+    'storage.videos', 'storage.logs', 'storage.thumbnails', 'storage.previews', 'storage.torrents', 'storage.cache', 'log.level',
     'cache.previews.size', 'admin.email', 'signup.enabled', 'signup.limit', 'transcoding.enabled', 'transcoding.threads', 'user.video_quota'
   ]
   const miss: string[] = []
diff --git a/server/initializers/constants.ts b/server/initializers/constants.ts
index c10213890..cb043251a 100644
--- a/server/initializers/constants.ts
+++ b/server/initializers/constants.ts
@@ -113,6 +113,9 @@ const CONFIG = {
     URL: '',
     HOST: ''
   },
+  LOG: {
+    LEVEL: config.get<string>('log.level')
+  },
   ADMIN: {
     get EMAIL () { return config.get<string>('admin.email') }
   },
diff --git a/server/models/activitypub/actor-follow.ts b/server/models/activitypub/actor-follow.ts
index 416496607..a32f5f498 100644
--- a/server/models/activitypub/actor-follow.ts
+++ b/server/models/activitypub/actor-follow.ts
@@ -376,7 +376,7 @@ export class ActorFollowModel extends Model<ActorFollowModel> {
           [Sequelize.Op.lte]: 0
         }
       },
-      logger: false
+      logging: false
     }
 
     return ActorFollowModel.findAll(query)
diff --git a/server/tests/api/server/config.ts b/server/tests/api/server/config.ts
index 0aa0e2ec1..a1f8212bb 100644
--- a/server/tests/api/server/config.ts
+++ b/server/tests/api/server/config.ts
@@ -112,6 +112,8 @@ describe('Test config', function () {
   })
 
   it('Should have the configuration updated after a restart', async function () {
+    this.timeout(10000)
+
     killallServers([ server ])
 
     await reRunServer(server)
@@ -134,6 +136,8 @@ describe('Test config', function () {
   })
 
   it('Should remove the custom configuration', async function () {
+    this.timeout(10000)
+
     await deleteCustomConfig(server.url, server.accessToken)
 
     const res = await getCustomConfig(server.url, server.accessToken)