MORPH
SIGN IN SIGN UP
Unitech / pm2 UNCLAIMED

Node.js Production Process Manager with a built-in Load Balancer.

43014 0 45 JavaScript
Normal View History Raw
refactor: replace chalk with smaller alternative
2025-05-08 23:25:06 +02:00
var chalk = require('ansis');
#2203 deep refactor
2016-06-04 14:04:26 +02:00
var util = require('util');
var fs = require('fs');
var exec = require('child_process').exec;
var path = require('path');
var Log = require('./Log');
var cst = require('../../constants.js');
var Common = require('../Common.js');
module.exports = function(CLI) {
/**
* Description
* @method flush
* @return
*/
added parameter to flush command(tests added)
2018-07-24 15:35:32 +03:00
CLI.prototype.flush = function(api, cb) {
refactor progress
2016-06-05 12:39:04 +02:00
var that = this;
fix: flush specific app should not flush all logs #4074
2018-12-18 13:48:04 +01:00
if (!api) {
Common.printOut(cst.PREFIX_MSG + 'Flushing ' + cst.PM2_LOG_FILE_PATH);
fs.closeSync(fs.openSync(cst.PM2_LOG_FILE_PATH, 'w'));
}
#2203 deep refactor
2016-06-04 14:04:26 +02:00
refactor progress
2016-06-05 12:39:04 +02:00
that.Client.executeRemote('getMonitorData', {}, function(err, list) {
#2203 deep refactor
2016-06-04 14:04:26 +02:00
if (err) {
Common.printError(err);
disable common.js interaction - move interactions to client
2016-06-05 14:10:05 +02:00
return cb ? cb(Common.retErr(err)) : that.exitCli(cst.ERROR_EXIT);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
}
list.forEach(function(l) {
fix: flush specific app should not flush all logs #4074
2018-12-18 13:48:04 +01:00
if (typeof api == 'undefined') {
Common.printOut(cst.PREFIX_MSG + 'Flushing:');
Common.printOut(cst.PREFIX_MSG + l.pm2_env.pm_out_log_path);
Common.printOut(cst.PREFIX_MSG + l.pm2_env.pm_err_log_path);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
added parameter to flush command(tests added)
2018-07-24 15:35:32 +03:00
if (l.pm2_env.pm_log_path) {
Common.printOut(cst.PREFIX_MSG + l.pm2_env.pm_log_path);
fs.closeSync(fs.openSync(l.pm2_env.pm_log_path, 'w'));
}
fs.closeSync(fs.openSync(l.pm2_env.pm_out_log_path, 'w'));
fs.closeSync(fs.openSync(l.pm2_env.pm_err_log_path, 'w'));
#2203 deep refactor
2016-06-04 14:04:26 +02:00
}
hotfix: replace non-working if-else condition to use fs.existsSync while handling flush
2023-01-20 13:59:32 +08:00
else if (l.pm2_env.pm_id == api || l.pm2_env.name === api) {
fix: flush specific app should not flush all logs #4074
2018-12-18 13:48:04 +01:00
Common.printOut(cst.PREFIX_MSG + 'Flushing:');
hotfix: replace non-working if-else condition to use fs.existsSync while handling flush
2023-01-20 13:59:32 +08:00
if (l.pm2_env.pm_log_path && fs.existsSync(l.pm2_env.pm_log_path)) {
added parameter to flush command(tests added)
2018-07-24 15:35:32 +03:00
Common.printOut(cst.PREFIX_MSG + l.pm2_env.pm_log_path);
fs.closeSync(fs.openSync(l.pm2_env.pm_log_path, 'w'));
}
#2203 deep refactor
2016-06-04 14:04:26 +02:00
hotfix: replace non-working if-else condition to use fs.existsSync while handling flush
2023-01-20 13:59:32 +08:00
if (l.pm2_env.pm_out_log_path && fs.existsSync(l.pm2_env.pm_out_log_path)) {
Common.printOut(cst.PREFIX_MSG + l.pm2_env.pm_out_log_path);
added parameter to flush command(tests added)
2018-07-24 15:35:32 +03:00
fs.closeSync(fs.openSync(l.pm2_env.pm_out_log_path, 'w'));
hotfix: replace non-working if-else condition to use fs.existsSync while handling flush
2023-01-20 13:59:32 +08:00
}
if (l.pm2_env.pm_err_log_path && fs.existsSync(l.pm2_env.pm_err_log_path)) {
Common.printOut(cst.PREFIX_MSG + l.pm2_env.pm_err_log_path);
added parameter to flush command(tests added)
2018-07-24 15:35:32 +03:00
fs.closeSync(fs.openSync(l.pm2_env.pm_err_log_path, 'w'));
hotfix: replace non-working if-else condition to use fs.existsSync while handling flush
2023-01-20 13:59:32 +08:00
}
added parameter to flush command(tests added)
2018-07-24 15:35:32 +03:00
}
#2203 deep refactor
2016-06-04 14:04:26 +02:00
});
fix: flush specific app should not flush all logs #4074
2018-12-18 13:48:04 +01:00
#2203 deep refactor
2016-06-04 14:04:26 +02:00
Common.printOut(cst.PREFIX_MSG + 'Logs flushed');
disable common.js interaction - move interactions to client
2016-06-05 14:10:05 +02:00
return cb ? cb(null, list) : that.exitCli(cst.SUCCESS_EXIT);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
});
};
refactor progress
2016-06-05 12:39:04 +02:00
CLI.prototype.logrotate = function(opts, cb) {
bugfix: variable "that" is not defined
2016-09-18 23:32:39 +08:00
var that = this;
#2203 deep refactor
2016-06-04 14:04:26 +02:00
if (process.getuid() != 0) {
return exec('whoami', function(err, stdout, stderr) {
Common.printError(cst.PREFIX_MSG + 'You have to run this command as root. Execute the following command:');
refactor: replace chalk with smaller alternative
2025-05-08 23:25:06 +02:00
Common.printError(cst.PREFIX_MSG + chalk.gray(' sudo env PATH=$PATH:' + path.dirname(process.execPath) + ' pm2 logrotate -u ' + stdout.trim()));
#2203 deep refactor
2016-06-04 14:04:26 +02:00
disable common.js interaction - move interactions to client
2016-06-05 14:10:05 +02:00
cb ? cb(Common.retErr('You have to run this with elevated rights')) : that.exitCli(cst.ERROR_EXIT);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
});
}
if (!fs.existsSync('/etc/logrotate.d')) {
Common.printError(cst.PREFIX_MSG + '/etc/logrotate.d does not exist we can not copy the default configuration.');
disable common.js interaction - move interactions to client
2016-06-05 14:10:05 +02:00
return cb ? cb(Common.retErr('/etc/logrotate.d does not exist')) : that.exitCli(cst.ERROR_EXIT);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
}
var templatePath = path.join(cst.TEMPLATE_FOLDER, cst.LOGROTATE_SCRIPT);
Common.printOut(cst.PREFIX_MSG + 'Getting logrorate template ' + templatePath);
var script = fs.readFileSync(templatePath, {encoding: 'utf8'});
var user = opts.user || 'root';
script = script.replace(/%HOME_PATH%/g, cst.PM2_ROOT_PATH)
.replace(/%USER%/g, user);
try {
fs.writeFileSync('/etc/logrotate.d/pm2-'+user, script);
} catch (e) {
console.error(e.stack || e);
}
Common.printOut(cst.PREFIX_MSG + 'Logrotate configuration added to /etc/logrotate.d/pm2');
disable common.js interaction - move interactions to client
2016-06-05 14:10:05 +02:00
return cb ? cb(null, {success:true}) : that.exitCli(cst.SUCCESS_EXIT);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
};
/**
* Description
* @method reloadLogs
* @return
*/
refactor progress
2016-06-05 12:39:04 +02:00
CLI.prototype.reloadLogs = function(cb) {
var that = this;
#2203 deep refactor
2016-06-04 14:04:26 +02:00
Common.printOut('Reloading all logs...');
refactor progress
2016-06-05 12:39:04 +02:00
that.Client.executeRemote('reloadLogs', {}, function(err, logs) {
#2203 deep refactor
2016-06-04 14:04:26 +02:00
if (err) {
Common.printError(err);
disable common.js interaction - move interactions to client
2016-06-05 14:10:05 +02:00
return cb ? cb(Common.retErr(err)) : that.exitCli(cst.ERROR_EXIT);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
}
Common.printOut('All logs reloaded');
disable common.js interaction - move interactions to client
2016-06-05 14:10:05 +02:00
return cb ? cb(null, logs) : that.exitCli(cst.SUCCESS_EXIT);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
});
};
/**
* Description
* @method streamLogs
* @param {String} id
* @param {Number} lines
* @param {Boolean} raw
* @return
*/
feat : log highlight option
2019-10-29 16:00:15 +05:30
CLI.prototype.streamLogs = function(id, lines, raw, timestamp, exclusive, highlight) {
refactor progress
2016-06-05 12:39:04 +02:00
var that = this;
#2203 deep refactor
2016-06-04 14:04:26 +02:00
var files_list = [];
// If no argument is given, we stream logs for all running apps
id = id || 'all';
lines = lines !== undefined ? lines : 20;
lines = lines < 0 ? -(lines) : lines;
// Avoid duplicates and check if path is different from '/dev/null'
var pushIfUnique = function(entry) {
var exists = false;
if (entry.path.toLowerCase
&& entry.path.toLowerCase() !== '/dev/null') {
files_list.some(function(file) {
if (file.path === entry.path)
exists = true;
return exists;
});
if (exists)
return;
files_list.push(entry);
}
}
// Get the list of all running apps
refactor progress
2016-06-05 12:39:04 +02:00
that.Client.executeRemote('getMonitorData', {}, function(err, list) {
Update pm2 logs to accept regex for names (#2924)
2017-06-06 17:45:39 +05:30
var regexList = [];
feat: print logs of a particular namespace pm2 logs <namespace>
2019-11-23 13:46:27 +05:30
var namespaceList = [];
#2998 pm2 report for automated reports
2017-07-04 20:13:15 +02:00
#2203 deep refactor
2016-06-04 14:04:26 +02:00
if (err) {
Common.printError(err);
disable common.js interaction - move interactions to client
2016-06-05 14:10:05 +02:00
that.exitCli(cst.ERROR_EXIT);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
}
(bugfix) #2868: fix --raw not display previous logs (#2876)
2017-05-21 07:29:19 +08:00
if (lines === 0)
feat : log highlight option
2019-10-29 16:00:15 +05:30
return Log.stream(that.Client, id, raw, timestamp, exclusive, highlight);
(pm2) refined pm2 log command with padding, better colors and multiple options, also fix #2105
2016-08-06 17:53:43 -07:00
refactor: replace chalk with smaller alternative
2025-05-08 23:25:06 +02:00
Common.printOut(chalk.bold.gray(util.format.call(this, '[TAILING] Tailing last %d lines for [%s] process%s (change the value with --lines option)', lines, id, id === 'all' ? 'es' : '')));
#2203 deep refactor
2016-06-04 14:04:26 +02:00
// Populate the array `files_list` with the paths of all files we need to tail
list.forEach(function(proc) {
if (proc.pm2_env && (id === 'all' ||
proc.pm2_env.name == id ||
proc.pm2_env.pm_id == id)) {
if (proc.pm2_env.pm_out_log_path && exclusive !== 'err')
pushIfUnique({
path : proc.pm2_env.pm_out_log_path,
(pm2) refined pm2 log command with padding, better colors and multiple options, also fix #2105
2016-08-06 17:53:43 -07:00
app_name :proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
#2203 deep refactor
2016-06-04 14:04:26 +02:00
type : 'out'});
if (proc.pm2_env.pm_err_log_path && exclusive !== 'out')
pushIfUnique({
path : proc.pm2_env.pm_err_log_path,
(pm2) refined pm2 log command with padding, better colors and multiple options, also fix #2105
2016-08-06 17:53:43 -07:00
app_name : proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
#2203 deep refactor
2016-06-04 14:04:26 +02:00
type : 'err'
});
feat: print logs of a particular namespace pm2 logs <namespace>
2019-11-23 13:46:27 +05:30
} else if(proc.pm2_env && proc.pm2_env.namespace == id) {
if(namespaceList.indexOf(proc.pm2_env.name) === -1) {
namespaceList.push(proc.pm2_env.name)
}
if (proc.pm2_env.pm_out_log_path && exclusive !== 'err')
pushIfUnique({
path : proc.pm2_env.pm_out_log_path,
app_name :proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
type : 'out'});
if (proc.pm2_env.pm_err_log_path && exclusive !== 'out')
pushIfUnique({
path : proc.pm2_env.pm_err_log_path,
app_name : proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
type : 'err'
});
#2203 deep refactor
2016-06-04 14:04:26 +02:00
}
Update pm2 logs to accept regex for names (#2924)
2017-06-06 17:45:39 +05:30
// Populate the array `files_list` with the paths of all files we need to tail, when log in put is a regex
else if(proc.pm2_env && (isNaN(id) && id[0] === '/' && id[id.length - 1] === '/')) {
var regex = new RegExp(id.replace(/\//g, ''));
if(regex.test(proc.pm2_env.name)) {
fix: only add each process name to regexList once
2019-05-14 14:45:55 +00:00
if(regexList.indexOf(proc.pm2_env.name) === -1) {
regexList.push(proc.pm2_env.name);
}
Update pm2 logs to accept regex for names (#2924)
2017-06-06 17:45:39 +05:30
if (proc.pm2_env.pm_out_log_path && exclusive !== 'err')
pushIfUnique({
path : proc.pm2_env.pm_out_log_path,
app_name : proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
type : 'out'});
if (proc.pm2_env.pm_err_log_path && exclusive !== 'out')
pushIfUnique({
path : proc.pm2_env.pm_err_log_path,
app_name : proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
type : 'err'
});
}
}
#2203 deep refactor
2016-06-04 14:04:26 +02:00
});
fix for issue #3506
2018-07-24 14:48:40 +03:00
//for fixing issue https://github.com/Unitech/pm2/issues/3506
/* if (files_list && files_list.length == 0) {
#3367 Display an error if the process is not found when running 'pm2 logs <process-name>'
2017-12-29 00:22:30 +01:00
Common.printError(cst.PREFIX_MSG_ERR + 'No file to stream for app [%s], exiting.', id);
return process.exit(cst.ERROR_EXIT);
fix for issue #3506
2018-07-24 14:48:40 +03:00
}*/
#3367 Display an error if the process is not found when running 'pm2 logs <process-name>'
2017-12-29 00:22:30 +01:00
#2203 deep refactor
2016-06-04 14:04:26 +02:00
if (!raw && (id === 'all' || id === 'PM2') && exclusive === false) {
Log.tail([{
path : cst.PM2_LOG_FILE_PATH,
app_name : 'PM2',
type : 'PM2'
}], lines, raw, function() {
Log.tail(files_list, lines, raw, function() {
feat : log highlight option
2019-10-29 16:00:15 +05:30
Log.stream(that.Client, id, raw, timestamp, exclusive, highlight);
#2203 deep refactor
2016-06-04 14:04:26 +02:00
});
});
}
else {
Log.tail(files_list, lines, raw, function() {
Update pm2 logs to accept regex for names (#2924)
2017-06-06 17:45:39 +05:30
if(regexList.length > 0) {
regexList.forEach(function(id) {
feat : log highlight option
2019-10-29 16:00:15 +05:30
Log.stream(that.Client, id, raw, timestamp, exclusive, highlight);
Update pm2 logs to accept regex for names (#2924)
2017-06-06 17:45:39 +05:30
})
}
feat: print logs of a particular namespace pm2 logs <namespace>
2019-11-23 13:46:27 +05:30
else if(namespaceList.length > 0) {
namespaceList.forEach(function(id) {
Log.stream(that.Client, id, raw, timestamp, exclusive, highlight);
})
}
Update pm2 logs to accept regex for names (#2924)
2017-06-06 17:45:39 +05:30
else {
feat : log highlight option
2019-10-29 16:00:15 +05:30
Log.stream(that.Client, id, raw, timestamp, exclusive, highlight);
Update pm2 logs to accept regex for names (#2924)
2017-06-06 17:45:39 +05:30
}
#2203 deep refactor
2016-06-04 14:04:26 +02:00
});
}
});
};
(logs) add option to only print logs (--nostream) #2620
2017-01-12 16:46:33 +01:00
/**
* Description
* @method printLogs
* @param {String} id
* @param {Number} lines
* @param {Boolean} raw
* @return
*/
CLI.prototype.printLogs = function(id, lines, raw, timestamp, exclusive) {
var that = this;
var files_list = [];
// If no argument is given, we stream logs for all running apps
id = id || 'all';
lines = lines !== undefined ? lines : 20;
lines = lines < 0 ? -(lines) : lines;
// Avoid duplicates and check if path is different from '/dev/null'
var pushIfUnique = function(entry) {
var exists = false;
if (entry.path.toLowerCase
&& entry.path.toLowerCase() !== '/dev/null') {
files_list.some(function(file) {
if (file.path === entry.path)
exists = true;
return exists;
});
if (exists)
return;
files_list.push(entry);
}
}
// Get the list of all running apps
that.Client.executeRemote('getMonitorData', {}, function(err, list) {
if (err) {
Common.printError(err);
that.exitCli(cst.ERROR_EXIT);
}
if (lines <= 0) {
return that.exitCli(cst.SUCCESS_EXIT)
}
refactor: replace chalk with smaller alternative
2025-05-08 23:25:06 +02:00
Common.printOut(chalk.bold.gray(util.format.call(this, '[TAILING] Tailing last %d lines for [%s] process%s (change the value with --lines option)', lines, id, id === 'all' ? 'es' : '')));
(logs) add option to only print logs (--nostream) #2620
2017-01-12 16:46:33 +01:00
// Populate the array `files_list` with the paths of all files we need to tail
list.forEach(function(proc) {
if (proc.pm2_env && (id === 'all' ||
proc.pm2_env.name == id ||
proc.pm2_env.pm_id == id)) {
if (proc.pm2_env.pm_out_log_path && exclusive !== 'err')
pushIfUnique({
path : proc.pm2_env.pm_out_log_path,
app_name :proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
type : 'out'});
if (proc.pm2_env.pm_err_log_path && exclusive !== 'out')
pushIfUnique({
path : proc.pm2_env.pm_err_log_path,
app_name : proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
type : 'err'
});
}
Update pm2 logs to accept regex for names (#2924)
2017-06-06 17:45:39 +05:30
// Populate the array `files_list` with the paths of all files we need to tail, when log in put is a regex
else if(proc.pm2_env && (isNaN(id) && id[0] === '/' && id[id.length - 1] === '/')) {
var regex = new RegExp(id.replace(/\//g, ''));
if(regex.test(proc.pm2_env.name)) {
if (proc.pm2_env.pm_out_log_path && exclusive !== 'err')
pushIfUnique({
path : proc.pm2_env.pm_out_log_path,
app_name : proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
type : 'out'});
if (proc.pm2_env.pm_err_log_path && exclusive !== 'out')
pushIfUnique({
path : proc.pm2_env.pm_err_log_path,
app_name : proc.pm2_env.pm_id + '|' + proc.pm2_env.name,
type : 'err'
});
}
}
(logs) add option to only print logs (--nostream) #2620
2017-01-12 16:46:33 +01:00
});
if (!raw && (id === 'all' || id === 'PM2') && exclusive === false) {
Log.tail([{
path : cst.PM2_LOG_FILE_PATH,
app_name : 'PM2',
type : 'PM2'
}], lines, raw, function() {
Log.tail(files_list, lines, raw, function() {
that.exitCli(cst.SUCCESS_EXIT);
});
});
}
else {
Log.tail(files_list, lines, raw, function() {
that.exitCli(cst.SUCCESS_EXIT);
});
}
});
};
#2203 deep refactor
2016-06-04 14:04:26 +02:00
};
Reference in New Issue Copy Permalink