MORPH
SIGN IN SIGN UP
Unitech / pm2 UNCLAIMED

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

43009 0 2 JavaScript
Normal View History Raw
(startup refactor)
2016-12-04 19:23:18 +01:00
/**
correct copyright year with start and end year (to be consistent)
2022-01-19 13:09:04 +01:00
* Copyright 2013-2022 the PM2 project authors. All rights reserved.
(startup refactor)
2016-12-04 19:23:18 +01:00
* Use of this source code is governed by a license that
* can be found in the LICENSE file.
*/
too fast exit feature added - log fixes
2013-05-24 17:24:31 +08:00
custom concurrent actions
2016-06-13 01:29:41 +02:00
var debug = require('debug')('pm2:conf');
var p = require('path');
var util = require('util');
refactor: replace chalk with smaller alternative
2025-05-08 23:25:06 +02:00
var chalk = require('ansis');
v0.0.999
2013-05-23 18:47:44 +08:00
support path relocation via PM2_HOME
2014-11-07 01:43:17 +01:00
/**
refactor progress
2016-06-05 12:39:04 +02:00
* Get PM2 path structure
support path relocation via PM2_HOME
2014-11-07 01:43:17 +01:00
*/
progress
2016-06-08 19:21:37 +02:00
var path_structure = require('./paths.js')(process.env.OVER_HOME);
Additional debug statements to track down any PM2_HOME issues
2015-02-01 23:59:37 -05:00
optional configuration file
2014-10-15 11:22:39 +02:00
/**
* Constants variables used by PM2
*/
var csts = {
refactor progress
2016-06-05 12:39:04 +02:00
PREFIX_MSG : chalk.green('[PM2] '),
#4765 automatically print applications logs on start/restart for 10secs
2020-06-30 10:47:15 +02:00
PREFIX_MSG_INFO : chalk.cyan('[PM2][INFO] '),
refactor progress
2016-06-05 12:39:04 +02:00
PREFIX_MSG_ERR : chalk.red('[PM2][ERROR] '),
(startup refactor)
2016-12-04 19:23:18 +01:00
PREFIX_MSG_MOD : chalk.bold.green('[PM2][Module] '),
refactor progress
2016-06-05 12:39:04 +02:00
PREFIX_MSG_MOD_ERR : chalk.red('[PM2][Module][ERROR] '),
PREFIX_MSG_WARNING : chalk.yellow('[PM2][WARN] '),
PREFIX_MSG_SUCCESS : chalk.cyan('[PM2] '),
feat: re-implement pm2 plus cli
2019-01-06 17:46:52 +01:00
PM2_IO_MSG : chalk.cyan('[PM2 I/O]'),
PM2_IO_MSG_ERR : chalk.red('[PM2 I/O]'),
refactor: split / remove unused code / DRY / pm2 enterprise|plus - breaking: .interact dropped
2018-07-13 18:29:33 +02:00
refactor progress
2016-06-05 12:39:04 +02:00
TEMPLATE_FOLDER : p.join(__dirname, 'lib/templates'),
change all ecosystem.json to ecosystem.config.js
2018-03-16 18:44:00 +01:00
APP_CONF_DEFAULT_FILE : 'ecosystem.config.js',
refactor progress
2016-06-05 12:39:04 +02:00
APP_CONF_TPL : 'ecosystem.tpl',
(CLI) pm2 ecosystem simple
2017-01-29 13:33:26 +01:00
APP_CONF_TPL_SIMPLE : 'ecosystem-simple.tpl',
refactor progress
2016-06-05 12:39:04 +02:00
SAMPLE_CONF_FILE : 'sample-conf.js',
LOGROTATE_SCRIPT : 'logrotate.d/pm2',
(docker integration) #2320 feature v1 POC (test+cmds+logic)
2016-08-14 13:21:05 +02:00
DOCKERFILE_NODEJS : 'Dockerfiles/Dockerfile-nodejs.tpl',
DOCKERFILE_JAVA : 'Dockerfiles/Dockerfile-java.tpl',
DOCKERFILE_RUBY : 'Dockerfiles/Dockerfile-ruby.tpl',
refactor progress
2016-06-05 12:39:04 +02:00
SUCCESS_EXIT : 0,
ERROR_EXIT : 1,
(constant) change exit code uncaught exception
2016-09-17 13:59:54 +02:00
CODE_UNCAUGHTEXCEPTION : 1,
refactor progress
2016-06-05 12:39:04 +02:00
Bun support
2024-11-12 13:54:46 +00:00
IS_BUN : typeof Bun !== 'undefined',
fix: #4442 allow to pass path in direct pm2 execution
2019-10-14 12:09:50 +02:00
IS_WINDOWS : (process.platform === 'win32' || process.platform === 'win64' || /^(msys|cygwin)$/.test(process.env.OSTYPE)),
refactor progress
2016-06-05 12:39:04 +02:00
ONLINE_STATUS : 'online',
STOPPED_STATUS : 'stopped',
STOPPING_STATUS : 'stopping',
feature: add exponential backoff restart delay via --exp-backoff-restart-delay
2018-09-27 17:05:40 +02:00
WAITING_RESTART : 'waiting restart',
refactor progress
2016-06-05 12:39:04 +02:00
LAUNCHING_STATUS : 'launching',
ERRORED_STATUS : 'errored',
ONE_LAUNCH_STATUS : 'one-launch-status',
CLUSTER_MODE_ID : 'cluster_mode',
FORK_MODE_ID : 'fork_mode',
disable git parsing by default #5909 #2182 #5801 #5051 #5696
2024-11-13 13:55:56 +01:00
ENABLE_GIT_PARSING : false,
#2501 low memory environment option via PM2_OPTIMIZE_MEMORY
2017-07-04 20:33:45 +02:00
LOW_MEMORY_ENVIRONMENT : process.env.PM2_OPTIMIZE_MEMORY || false,
Update constants.js
2019-04-19 11:44:48 +02:00
MACHINE_NAME : process.env.INSTANCE_NAME || process.env.MACHINE_NAME || process.env.PM2_MACHINE_NAME,
refactor: centralize SECRET/PUBLIC/MACHINE_NAME + change some wordings
2018-05-10 20:09:13 +02:00
SECRET_KEY : process.env.KEYMETRICS_SECRET || process.env.PM2_SECRET_KEY || process.env.SECRET_KEY,
PUBLIC_KEY : process.env.KEYMETRICS_PUBLIC || process.env.PM2_PUBLIC_KEY || process.env.PUBLIC_KEY,
Update constants.js
2019-04-19 11:44:48 +02:00
KEYMETRICS_ROOT_URL : process.env.KEYMETRICS_NODE || process.env.PM2_APM_ADDRESS || process.env.ROOT_URL || process.env.INFO_NODE || 'root.keymetrics.io',
refactor: centralize SECRET/PUBLIC/MACHINE_NAME + change some wordings
2018-05-10 20:09:13 +02:00
fix: path
2018-07-13 18:41:18 +02:00
PM2_BANNER : '../lib/motd',
PM2_UPDATE : '../lib/API/pm2-plus/pres/motd.update',
refactor progress
2016-06-05 12:39:04 +02:00
DEFAULT_MODULE_JSON : 'package.json',
first partial commit to support local tarball module install (install + respawn on boot) + refactor of module system
2018-09-24 14:42:40 +02:00
MODULE_BASEFOLDER: 'module',
MODULE_CONF_PREFIX: 'module-db-v2',
MODULE_CONF_PREFIX_TAR: 'tar-modules',
#3928 reset restart delay once application is in stable mode
2018-10-03 11:17:53 +02:00
EXP_BACKOFF_RESET_TIMER : parseInt(process.env.EXP_BACKOFF_RESET_TIMER) || 30000,
refactor progress
2016-06-05 12:39:04 +02:00
REMOTE_PORT_TCP : isNaN(parseInt(process.env.KEYMETRICS_PUSH_PORT)) ? 80 : parseInt(process.env.KEYMETRICS_PUSH_PORT),
REMOTE_PORT : 41624,
REMOTE_HOST : 's1.keymetrics.io',
SEND_INTERVAL : 1000,
#2951 pm2 reload timestamped lockfile
2017-06-27 23:53:52 +02:00
RELOAD_LOCK_TIMEOUT : parseInt(process.env.PM2_RELOAD_LOCK_TIMEOUT) || 30000,
refactor progress
2016-06-05 12:39:04 +02:00
GRACEFUL_TIMEOUT : parseInt(process.env.PM2_GRACEFUL_TIMEOUT) || 8000,
GRACEFUL_LISTEN_TIMEOUT : parseInt(process.env.PM2_GRACEFUL_LISTEN_TIMEOUT) || 3000,
(interactor) attach logs based on application name
2017-06-20 21:14:43 +02:00
LOGS_BUFFER_SIZE : 8,
(error-reporting) resolve context from pmx error
2017-02-07 14:45:02 +01:00
CONTEXT_ON_ERROR : 2,
(aggregator) set low aggregation duration when NODE_ENV=local_test
2017-07-05 10:12:59 +02:00
AGGREGATION_DURATION : process.env.PM2_DEBUG || process.env.NODE_ENV === 'local_test' || process.env.NODE_ENV === 'development' ? 3000 : 5 * 60000,
(trace) refactor + handle exit/restarts
2017-02-27 01:03:59 +01:00
TRACE_FLUSH_INTERVAL : process.env.PM2_DEBUG || process.env.NODE_ENV === 'local_test' ? 1000 : 60000,
refactor progress
2016-06-05 12:39:04 +02:00
custom concurrent actions
2016-06-13 01:29:41 +02:00
// Concurrent actions when doing start/restart/reload
restore 0.12 support
2017-04-27 00:42:05 +02:00
CONCURRENT_ACTIONS : (function() {
refactor: faster cli with less require
2018-05-17 23:34:48 +02:00
var concurrent_actions = parseInt(process.env.PM2_CONCURRENT_ACTIONS) || 2;
add back CONCURRENT_ACTIONS function
2016-06-20 23:35:55 +02:00
debug('Using %d parallelism (CONCURRENT_ACTIONS)', concurrent_actions);
return concurrent_actions;
restore 0.12 support
2017-04-27 00:42:05 +02:00
})(),
refactor progress
2016-06-05 12:39:04 +02:00
DEBUG : process.env.PM2_DEBUG || false,
Allows to specify an IP Address for the WEB API to bind on
2016-07-23 14:17:32 +00:00
WEB_IPADDR : process.env.PM2_API_IPADDR || '0.0.0.0',
WEB_PORT : parseInt(process.env.PM2_API_PORT) || 9615,
Stripping environment variables from the HttpInterface (#2895) * Fixes 452 * Renamed to `proc` * Default to false to keep backwards compatibility
2017-05-23 23:48:21 +02:00
WEB_STRIP_ENV_VARS : process.env.PM2_WEB_STRIP_ENV_VARS || false,
refactor progress
2016-06-05 12:39:04 +02:00
MODIFY_REQUIRE : process.env.PM2_MODIFY_REQUIRE || false,
WORKER_INTERVAL : process.env.PM2_WORKER_INTERVAL || 30000,
KILL_TIMEOUT : process.env.PM2_KILL_TIMEOUT || 1600,
Extracted kill signal to the constants.js. Added new environment variable 'PM2_KILL_USE_SEND' (false by default) to allow PM2 to use process.send() instead of the process.kill() from the God.killProcess() method. This allows applications not to depend on the platform-specific signal behavior and eventually have a graceful shutdown capability on Windows.
2019-10-17 14:55:52 -07:00
KILL_SIGNAL : process.env.PM2_KILL_SIGNAL || 'SIGINT',
feat: send signal via env PM2_KILL_USE_MESSAGE or --shutdown-with-message
2019-10-30 13:54:01 +01:00
KILL_USE_MESSAGE : process.env.PM2_KILL_USE_MESSAGE || false,
Extracted kill signal to the constants.js. Added new environment variable 'PM2_KILL_USE_SEND' (false by default) to allow PM2 to use process.send() instead of the process.kill() from the God.killProcess() method. This allows applications not to depend on the platform-specific signal behavior and eventually have a graceful shutdown capability on Windows.
2019-10-17 14:55:52 -07:00
(programmatic) allow to do PM2 CLI commands from inside scripts
2016-09-19 11:45:05 +02:00
PM2_PROGRAMMATIC : typeof(process.env.pm_id) !== 'undefined' || process.env.PM2_PROGRAMMATIC,
faster logs throughput date parsing by replacing moment by date-fns in PM2 Daemon + homogeneize all logs with same date format + factorize ForkMode logging
2018-09-23 23:33:42 +02:00
PM2_LOG_DATE_FORMAT : process.env.PM2_LOG_DATE_FORMAT !== undefined ? process.env.PM2_LOG_DATE_FORMAT : 'YYYY-MM-DDTHH:mm:ss'
optional configuration file
2014-10-15 11:22:39 +02:00
refactor progress
2016-06-05 12:39:04 +02:00
};
optional configuration file
2014-10-15 11:22:39 +02:00
refactor: replace deprecated util._extend with Object.assign
2021-12-04 18:00:15 +08:00
module.exports = Object.assign(csts, path_structure);
Reference in New Issue Copy Permalink