Feature/logrotation (#1881)

* #1775 Configure the activation or deactivation of winston log rotation

* Winston log rotation enabled by default #1775

* #1775 tslint correction

* #1775 FileTransportOptions typed and configuration files

* #1775 tslint correction

* #1775 log.rotation.enabled configuration binding

diff --git a/config/default.yaml b/config/default.yaml
index e4e2d2273060d8ba23e491d54325b9ed7a7720ef..a213d5b0a768fbd6983ee2f65095ac187969e828 100644 (file)
--- a/config/default.yaml
+++ b/config/default.yaml
@@ -75,6 +75,8 @@ storage:
 
 log:
   level: 'info' # debug/info/warning/error
+  rotation:
+    enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
 
 search:
   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance

diff --git a/config/production.yaml.example b/config/production.yaml.example
index bd0d956bdb979008596495049f2978c83f4f31e4..cdf6136d85b21b6d6f7c8bda479f8c1f069187cd 100644 (file)
--- a/config/production.yaml.example
+++ b/config/production.yaml.example
@@ -76,6 +76,8 @@ storage:
 
 log:
   level: 'info' # debug/info/warning/error
+  rotation:
+    enabled : true
 
 search:
   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance

diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts
index 734523b01b37388962641a91325dd6780674f591..8603dd76127afe0a7b253db9460e1d6cbf334b93 100644 (file)
--- a/server/helpers/logger.ts
+++ b/server/helpers/logger.ts
@@ -2,6 +2,7 @@
 import { mkdirpSync } from 'fs-extra'
 import * as path from 'path'
 import * as winston from 'winston'
+import { FileTransportOptions } from 'winston/lib/winston/transports'
 import { CONFIG } from '../initializers/config'
 import { omit } from 'lodash'
 
@@ -45,6 +46,21 @@ const labelFormatter = winston.format.label({
   label
 })
 
+const fileLoggerOptions: FileTransportOptions = {
+
+  filename: path.join(CONFIG.STORAGE.LOG_DIR, 'peertube.log'),
+  handleExceptions: true,
+  format: winston.format.combine(
+    winston.format.timestamp(),
+    jsonLoggerFormat
+  )
+}
+
+if (CONFIG.LOG.ROTATION) {
+  fileLoggerOptions.maxsize = 1024 * 1024 * 12
+  fileLoggerOptions.maxFiles = 20
+}
+
 const logger = winston.createLogger({
   level: CONFIG.LOG.LEVEL,
   format: winston.format.combine(
@@ -52,16 +68,7 @@ const logger = winston.createLogger({
     winston.format.splat()
   ),
   transports: [
-    new winston.transports.File({
-      filename: path.join(CONFIG.STORAGE.LOG_DIR, 'peertube.log'),
-      handleExceptions: true,
-      maxsize: 1024 * 1024 * 12,
-      maxFiles: 20,
-      format: winston.format.combine(
-        winston.format.timestamp(),
-        jsonLoggerFormat
-      )
-    }),
+    new winston.transports.File(fileLoggerOptions),
     new winston.transports.Console({
       handleExceptions: true,
       format: winston.format.combine(

diff --git a/server/initializers/config.ts b/server/initializers/config.ts
index 2be300a57d66997a678280b6612993b00e3c4ffe..50653b0a0b1e821abead4af8017806b6e5b159fc 100644 (file)
--- a/server/initializers/config.ts
+++ b/server/initializers/config.ts
@@ -83,7 +83,8 @@ const CONFIG = {
   },
   TRUST_PROXY: config.get<string[]>('trust_proxy'),
   LOG: {
-    LEVEL: config.get<string>('log.level')
+    LEVEL: config.get<string>('log.level'),
+    ROTATION: config.get<boolean>('log.rotation.enabled')
   },
   SEARCH: {
     REMOTE_URI: {