pm2-logrotate 2.6.0 → 3.0.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+
+# 3.0.0
+
+- Update deps
+- Windows behavior fix
+
+# 2.7.0
+
+- [#129] fix overwrite logs in cluster mode (@EllieSummer)
+- [#90] Fixed typo by changing GMT-1 to GMT+1 to match the tz (@nitrocode)

package/README.md

@@ -7,9 +7,7 @@ PM2 module to automatically rotate logs of processes managed by PM2.
 
     pm2 install pm2-logrotate
 
-To install a specific version use the `@<version>` suffix
-
-    pm2 install pm2-logrotate@2.2.0
+**NOTE:** the command is `pm2 install` NOT `npm install`
 
 ## Configure
 
@@ -21,7 +19,7 @@ To install a specific version use the `@<version>` suffix
 - `workerInterval` (Defaults to `30` in secs) : You can control at which interval the worker is checking the log's size (minimum is `1`)
 - `rotateInterval` (Defaults to `0 0 * * *` everyday at midnight): This cron is used to a force rotate when executed.
 We are using [node-schedule](https://github.com/node-schedule/node-schedule) to schedule cron, so all valid cron for [node-schedule](https://github.com/node-schedule/node-schedule) is valid cron for this option. Cron style :
-- `TZ` (Defaults to system time): This is the standard [tz database timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used to offset the log file saved. For instance, a value of `Etc/GMT-1`, with an hourly log, will save a file at hour `14` GMT with hour `13` GMT-1 in the log name.
+- `TZ` (Defaults to system time): This is the standard [tz database timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used to offset the log file saved. For instance, a value of `Etc/GMT+1`, with an hourly log, will save a file at hour `14` GMT with hour `13` (GMT+1) in the log name.
 
 ```
 *    *    *    *    *    *
@@ -35,6 +33,10 @@ We are using [node-schedule](https://github.com/node-schedule/node-schedule) to
 └───────────────────────── second (0 - 59, OPTIONAL)
 ```
 
+### How to view current configuration of the above values ?
+After having installed the module, you have to type :
+`pm2 conf`
+
 ### How to set these values ?
 
  After having installed the module you have to type :

package/app.js

@@ -35,15 +35,21 @@ else if (process.env.HOME && !process.env.HOMEPATH)
 else if (process.env.HOME || process.env.HOMEPATH)
   PM2_ROOT_PATH = path.resolve(process.env.HOMEDRIVE, process.env.HOME || process.env.HOMEPATH, '.pm2');
 
+const parseBool = (str, defaultVal = false) => {
+  if (str === 'true') return true;
+  if (str === 'false') return false;
+  return defaultVal;
+};
+
 var WORKER_INTERVAL = isNaN(parseInt(conf.workerInterval)) ? 30 * 1000 : 
                             parseInt(conf.workerInterval) * 1000; // default: 30 secs
 var SIZE_LIMIT = get_limit_size(); // default : 10MB
 var ROTATE_CRON = conf.rotateInterval || "0 0 * * *"; // default : every day at midnight
 var RETAIN = isNaN(parseInt(conf.retain)) ? undefined : parseInt(conf.retain); // All
-var COMPRESSION = JSON.parse(conf.compress) || false; // Do not compress by default
+var COMPRESSION = parseBool(conf.compress, false); // Do not compress by default
 var DATE_FORMAT = conf.dateFormat || 'YYYY-MM-DD_HH-mm-ss';
 var TZ = conf.TZ;
-var ROTATE_MODULE = JSON.parse(conf.rotateModule) || true;
+var ROTATE_MODULE = parseBool(conf.rotateModule, true);
 var WATCHED_FILES = [];
 
 function get_limit_size() {
@@ -62,7 +68,7 @@ function get_limit_size() {
 
 function delete_old(file) {
   if (file === "/dev/null") return;
-  var fileBaseName = file.substr(0, file.length - 4).split('/').pop() + "__";
+  var fileBaseName = path.basename(file, '.log') + "__";
   var dirName = path.dirname(file);
 
   fs.readdir(dirName, function(err, files) {
@@ -199,10 +205,16 @@ pm2.connect(function(err) {
     pm2.list(function(err, apps) {
       if (err) return console.error(err.stack || err);
 
+      var appMap = {};
       // rotate log that are bigger than the limit
       apps.forEach(function(app) {
           // if its a module and the rotate of module is disabled, ignore
           if (typeof(app.pm2_env.axm_options.isModule) !== 'undefined' && !ROTATE_MODULE) return ;
+
+          // if apps instances are multi and one of the instances has rotated, ignore
+          if(app.pm2_env.instances > 1 && appMap[app.name]) return;
+          
+          appMap[app.name] = app;
           
           proceed_app(app, false);
       });
@@ -219,11 +231,17 @@ pm2.connect(function(err) {
     pm2.list(function(err, apps) {
         if (err) return console.error(err.stack || err);
 
+        var appMap = {};
         // force rotate for each app
         apps.forEach(function(app) {
           // if its a module and the rotate of module is disabled, ignore
           if (typeof(app.pm2_env.axm_options.isModule) !== 'undefined' && !ROTATE_MODULE) return ;
 
+          // if apps instances are multi and one of the instances has rotated, ignore
+          if(app.pm2_env.instances > 1 && appMap[app.name]) return;
+
+          appMap[app.name] = app;
+
           proceed_app(app, true);
         });
       });

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "pm2-logrotate",
-  "version": "2.6.0",
+  "version": "3.0.0",
   "description": "Module to rotate logs of every pm2 application",
   "main": "app.js",
   "dependencies": {
-    "graceful-fs": "^4.1.11",
+    "graceful-fs": "^4.2.2",
     "moment-timezone": "^0.5.11",
-    "node-schedule": "^1.1.1",
+    "node-schedule": "^1.3.1",
     "pm2": "latest",
     "pmx": "latest"
   },

package/test/echo.js

@@ -0,0 +1,4 @@
+
+setInterval(() => {
+  console.log('test line')
+}, 2000)