Blame: lib/API/schema.json - Unitech/pm2

Unitech / pm2 UNCLAIMED

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

43014 0 45 JavaScript

1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`{`
			`"script": {`
			`"type": "string",`
(JSON config) alias script to exec 2017-01-16 14:04:32 +01:00			`"require": true,`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"alias" : "exec",`
			`"docDescription": "Path of the script to launch, required field"`
			`},`
			`"name": {`
			`"type": "string",`
			`"docDefault": "Script filename without the extension (app for app.js)",`
			`"docDescription": "Process name in the process list"`
			`},`
drop v1 modules logic and tests + v1 of tarball module management + add Common.err and Common.log helper with auto prefix + split module logic 2018-09-24 22:55:18 +02:00			`"name_prefix": {`
			`"type": "string"`
			`},`
filter_env to skip local env variables #4596 2020-04-12 16:50:03 +02:00			`"filter_env": {`
			`"type": [`
			`"boolean",`
			`"array",`
			`"string"`
			`],`
			`"docDefault": false,`
			`"docDescription": "Enable filtering global environments"`
			`},`
Add process namespaces feature 2019-10-28 13:33:28 +05:30			`"namespace": {`
			`"type": "string",`
			`"docDefault": "default",`
			`"docDescription": "Process namespace"`
			`},`
module: bind install url 2018-09-29 16:40:29 +02:00			`"install_url": {`
			`"type": "string"`
			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"cwd": {`
			`"type": "string",`
			`"docDefault": "CWD of the current environment (from your shell)",`
			`"docDescription": "Current working directory to start the process with"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
			`"args": {`
			`"type": [`
			`"array",`
			`"string"`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`],`
			`"docDescription": "Arguments to pass to the script"`
			`},`
			`"exec_interpreter": {`
			`"type": "string",`
			`"alias": "interpreter",`
			`"docDefault": "node",`
			`"docDescription": "Interpreter absolute path"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
			`"node_args": {`
			`"type": [`
			`"array",`
			`"string"`
enhancements: allow multiple aliases in schema.json + allow to use same conf attributes in both JSON and CLI + add tests for extra languages like pypy and php #517 #2031 2016-03-24 21:35:55 +01:00			`],`
fix bug with interpreter args 2018-03-16 17:40:23 +01:00			`"alias": ["interpreterArgs", "interpreter_args"],`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"docDescription": "Arguments to pass to the interpreter"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"out_file": {`
			`"type": "string",`
			`"alias": ["out", "output", "out_log"],`
			`"docDefault": "~/.pm2/logs/<app_name>-out.log",`
			`"docDescription": "File path for stdout (each line is appended to this file)"`
			`},`
			`"error_file": {`
			`"type": "string",`
			`"alias": ["error", "err", "err_file", "err_log"],`
			`"docDefault": "~/.pm2/logs/<app_name>-error.err",`
			`"docDescription": "File path for stderr (each line is appended to this file)"`
			`},`
			`"log_file": {`
			`"type": [`
			`"boolean",`
			`"string"`
			`],`
			`"alias": "log",`
			`"docDefault": "/dev/null",`
			`"docDescription": "File path for combined stdout and stderr (each line is appended to this file)"`
			`},`
			`"disable_logs": {`
			`"type": "boolean",`
			`"docDefault": false,`
			`"docDescription": "Disable all logs storage"`
			`},`
			`"log_type": {`
			`"type": "string",`
			`"docDescription": "Define a specific log output type, possible value: json"`
			`},`
			`"log_date_format": {`
			`"type": "string",`
chore fix schema.json 2020-04-12 15:56:43 +02:00			`"docDescription": "Format for log timestamps in day.js format (eg YYYY-MM-DD HH:mm Z)"`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`},`
--time to enable log date prefixing 2018-09-24 00:17:23 +02:00			`"time": {`
			`"type": "boolean"`
			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"env": {`
			`"type": [`
			`"object",`
			`"string"`
			`],`
			`"docDescription": "Specify environment variables to be injected"`
			`},`
			`"^env_\\S*$": {`
			`"type": [`
			`"object",`
			`"string"`
			`],`
			`"docDescription": "Specify environment variables to be injected when using --env <env_name>"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
			`"max_memory_restart": {`
			`"type": [`
			`"string",`
			`"number"`
			`],`
			`"regex": "^\\d+(G\|M\|K)?$",`
			`"ext_type": "sbyte",`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"desc": "it should be a NUMBER - byte, \"[NUMBER]G\"(Gigabyte), \"[NUMBER]M\"(Megabyte) or \"[NUMBER]K\"(Kilobyte)",`
			`"docDescription": "Restart the app if an amount of memory is exceeded (format: /[0-9](K\|M\|G)?/ K for KB, 'M' for MB, 'G' for GB, default to B)"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"pid_file": {`
			`"type": "string",`
			`"alias": "pid",`
			`"docDefault": "~/.pm2/pids/app_name-id.pid",`
			`"docDescription": "File path where the pid of the started process is written by pm2"`
#2144 #1060 #2957 #2033 #1872 #2938 #971 Select application uid/gid via --uid --gid (CLI+JSON) + pm2 install --uid / --gid 2017-07-02 19:28:41 +02:00			`},`
feature: --restart-delay flag 2015-08-04 15:24:47 +02:00			`"restart_delay": {`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"type" : "number",`
			`"docDefault": 0,`
			`"docDescription": "Time in ms to wait before restarting a crashing app"`
feature: --restart-delay flag 2015-08-04 15:24:47 +02:00			`},`
feature: add exponential backoff restart delay via --exp-backoff-restart-delay 2018-09-27 17:05:40 +02:00			`"exp_backoff_restart_delay": {`
			`"type": "number",`
			`"docDefault": 0,`
			`"docDescription": "Restart Time in ms to wait before restarting a crashing app"`
			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"source_map_support": {`
			`"type": "boolean",`
			`"docDefault": true,`
			`"docDescription": "Enable or disable the source map support"`
fix: allow to disable source map auto detection [#1980] 2016-02-29 17:09:34 +01:00			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"disable_source_map_support": {`
			`"type": "boolean",`
			`"docDefault": false,`
			`"docDescription": "Enable or disable the source map support"`
(feature) wait for application ready event when asked 2016-10-26 18:53:05 +02:00			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"wait_ready": {`
			`"type": "boolean",`
			`"docDefault": false,`
			`"docDescription": "Make the process wait for a process.send('ready')"`
feature: add source map support [#1980] 2016-02-28 22:32:03 +01:00			`},`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`"instances": {`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"type": "number",`
			`"docDefault": 1,`
			`"docDescription": "Number of instances to be started in cluster mode"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
#1810 add --kill-timeout <number> option to configure delay before SIGKILL 2015-12-14 18:46:48 +01:00			`"kill_timeout": {`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"type": "number",`
			`"docDefault": 1600,`
			`"docDescription": "Time in ms before sending the final SIGKILL signal after SIGINT"`
#1810 add --kill-timeout <number> option to configure delay before SIGKILL 2015-12-14 18:46:48 +01:00			`},`
feat: send signal via env PM2_KILL_USE_MESSAGE or --shutdown-with-message 2019-10-30 13:54:01 +01:00			`"shutdown_with_message": {`
			`"type": "boolean",`
			`"docDefault": false,`
			`"docDescription": "Shutdown an application with process.send('shutdown') instead of process.kill(pid, SIGINT)"`
			`},`
#2261 --listen-timeout to configure timeout before app is bind to port 2016-07-04 23:12:23 +02:00			`"listen_timeout": {`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"type": "number",`
			`"docDescription": "Time in ms before forcing a reload if app is still not listening/has still note sent ready"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
			`"cron_restart": {`
cron restarts improvements 2021-09-24 12:40:46 +02:00			`"type": [`
			`"string",`
			`"number"`
			`],`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"alias": "cron",`
			`"docDescription": "A cron pattern to restart your app"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
			`"merge_logs": {`
enhancements: allow multiple aliases in schema.json + allow to use same conf attributes in both JSON and CLI + add tests for extra languages like pypy and php #517 #2031 2016-03-24 21:35:55 +01:00			`"type": "boolean",`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"alias" : "combine_logs",`
			`"docDefault": false,`
			`"docDescription": "In cluster mode, merge each type of logs into a single file (instead of having one for each cluster)"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"vizion": {`
refactoring + added default attribute in JSON validation + consistency between JSON starts and CLI starts 2015-12-15 02:07:25 +01:00			`"type": "boolean",`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"default" : true,`
			`"docDefault" : "True",`
			`"docDescription": "Enable or disable the versioning metadatas (vizion library)"`
new flags --no-vizion and --no-autorestart 2015-04-16 16:20:53 +02:00			`},`
Added autostart parameter to optionally prevent immediately starting applications (cherry picked from commit b34498f45e6138a6e7f31c6a7f0ddfed768eee76) 2024-03-01 15:02:04 +01:00			`"autostart": {`
			`"type": "boolean",`
			`"default": true,`
			`"docDefault": "True",`
			`"docDescription": "Enable or disable auto start when adding process"`
			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"autorestart": {`
refactoring + added default attribute in JSON validation + consistency between JSON starts and CLI starts 2015-12-15 02:07:25 +01:00			`"type": "boolean",`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"default": true,`
			`"docDefault": "True",`
			`"docDescription": "Enable or disable auto restart after process failure"`
Add a --no-treekill option to avoid killing detached processes 2015-06-26 14:52:32 +02:00			`},`
feat: stop-exit-codes 2022-03-18 23:40:40 +00:00			`"stop_exit_codes": {`
			`"type": [`
			`"array",`
			`"number"`
			`],`
			`"docDescription": "List of exit codes that should allow the process to stop (skip autorestart)."`
			`},`
refactor + fix bug watch_delay on json + add user mgmt tests + change tests order/remove toxic flag 2018-09-23 19:28:13 +02:00			`"watch_delay": {`
			`"type": "number",`
			`"docDefault": "True",`
			`"docDescription": "Restart delay on file change detected"`
			`},`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`"watch": {`
allow array and string for watch option -- add some tests for JSON validation 2014-11-25 18:14:27 +01:00			`"type": [`
			`"boolean",`
			`"array",`
			`"string"`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`],`
			`"docDefault": false,`
			`"docDescription": "Enable or disable the watch mode"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
			`"ignore_watch": {`
			`"type": [`
			`"array",`
			`"string"`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`],`
			`"docDescription": "List of paths to ignore (regex)"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
Add options for chokidar - fix #931 #870 2015-01-28 22:55:32 +01:00			`"watch_options": {`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"type": "object",`
			`"docDescription": "Object that will be used as an options with chokidar (refer to chokidar documentation)"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
			`"min_uptime": {`
			`"type": [`
			`"number",`
			`"string"`
			`],`
			`"regex": "^\\d+(h\|m\|s)?$",`
			`"desc": "it should be a NUMBER - milliseconds, \"[NUMBER]h\"(hours), \"[NUMBER]m\"(minutes) or \"[NUMBER]s\"(seconds)",`
			`"min": 100,`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"ext_type": "stime",`
			`"docDefault": 1000,`
			`"docDescription": "Minimum uptime of the app to be considered started (format is /[0-9]+(h\|m\|s)?/, for hours, minutes, seconds, docDefault to ms)"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
			`"max_restarts": {`
			`"type": "number",`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"min": 0,`
			`"docDefault": 16,`
			`"docDescription": "Number of times a script is restarted when it exits in less than min_uptime"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
chore: adapt tests 2018-09-20 14:10:37 +02:00			`"execute_command": {`
			`"type": "boolean"`
			`},`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`"exec_mode": {`
			`"type": "string",`
			`"regex": "^(cluster\|fork)(_mode)?$",`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"desc": "it should be \"cluster\"(\"cluster_mode\") or \"fork\"(\"fork_mode\") only",`
			`"docDefault": "fork",`
			`"docDescription": "Set the execution mode, possible values: fork\|cluster"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`},`
			`"force": {`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"type": "boolean",`
			`"docDefault": false,`
			`"docDescription": "Start a script even if it is already running (only the script path is considered)"`
1. add `post_update` schema; 2. fix log path bug. 2014-11-24 17:16:26 +08:00			`},`
(enchancement) appendEnvToName -> snake_case + tests 2017-01-24 17:37:35 +01:00			`"append_env_to_name": {`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"type": "boolean",`
			`"docDefault": false,`
			`"docDescription": "Append the environment name to the app name"`
Allow starting processes for each environment 2017-01-23 00:28:53 +05:30			`},`
1. add `post_update` schema; 2. fix log path bug. 2014-11-24 17:16:26 +08:00			`"post_update": {`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"type": "array",`
			`"docDescription": "List of commands executed after a pull/upgrade operation performed from Keymetrics dashboard"`
(transactions) enable tracing via options 2017-01-04 17:02:11 +01:00			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"trace": {`
(CLI) --disable-trace 2017-01-17 15:25:43 +01:00			`"type": [`
			`"boolean"`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`],`
			`"docDefault": false,`
			`"docDescription": "Enable or disable the transaction tracing"`
(CLI) --disable-trace 2017-01-17 15:25:43 +01:00			`},`
			`"disable_trace": {`
(trace) refactor method to enable tracing 2017-01-06 16:22:07 +01:00			`"type": [`
			`"boolean"`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`],`
			`"docDefault": true,`
			`"docDescription": "Enable or disable the transaction tracing"`
(increment) allow to increment a env variable with a options #2743 2017-06-06 15:49:43 +02:00			`},`
feat: allow pm2 to enable v8 data collecting from pmx 2018-01-31 15:08:31 +01:00			`"v8": {`
			`"type": [`
			`"boolean"`
			`]`
			`},`
fix: replace dash with underscore 2018-02-02 18:07:50 +01:00			`"event_loop_inspector": {`
feat: allow pm2 to install and enable event-loop-inspector data collecting 2018-02-02 14:56:23 +01:00			`"type": [`
			`"boolean"`
			`]`
			`},`
feat: add flag to enable deep-monitoring 2018-02-05 15:10:21 +01:00			`"deep_monitoring": {`
			`"type": [`
			`"boolean"`
			`]`
			`},`
(increment) allow to increment a env variable with a options #2743 2017-06-06 15:49:43 +02:00			`"increment_var": {`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"type": "string",`
			`"docDescription": "Specify the name of an environment variable to inject which increments for each cluster"`
(instance_var) allow to overide the key NODE_APP_INSTANCE #2045 2017-06-06 15:57:32 +02:00			`},`
			`"instance_var": {`
			`"type": "string",`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"default": "NODE_APP_INSTANCE",`
			`"docDefault": "NODE_APP_INSTANCE",`
			`"docDescription": "Rename the NODE_APP_INSTANCE environment variable"`
			`},`
			`"pmx": {`
feat: allow pmx attribute to be string 2021-01-13 12:31:05 +01:00			`"type": ["boolean", "string"],`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"default": true,`
			`"docDefault": "True",`
			`"docDescription": "Enable or disable pmx wrapping"`
			`},`
			`"automation": {`
			`"type": "boolean",`
			`"default": true,`
			`"docDefault": "True",`
			`"docDescription": "Enable or disable pmx wrapping"`
			`},`
			`"treekill": {`
			`"type": "boolean",`
			`"default": true,`
			`"docDefault": "True",`
#3651 fix username undefined 2018-06-03 20:53:09 +02:00			`"docDescription": "Only kill the main process, not detached children"`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`},`
			`"port": {`
			`"type": "number",`
			`"docDescription": "Shortcut to inject a PORT environment variable"`
			`},`
#3651 fix username undefined 2018-06-03 20:53:09 +02:00			`"username" : {`
			`"type": "string",`
			`"docDescription": "Current user that started the process"`
			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"uid": {`
Allow usernames in uid/gid/user again (fixes #4262) 2019-05-06 18:02:57 +03:00			`"type" : [`
			`"number",`
			`"string"`
			`],`
proper support of setting the right user in fork mode (uid/user resolution + HOME set) 2018-09-23 17:48:27 +02:00			`"alias": "user",`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"docDefault": "Current user uid",`
#3651 fix username undefined 2018-06-03 20:53:09 +02:00			`"docDescription": "Set user id"`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`},`
			`"gid": {`
Allow usernames in uid/gid/user again (fixes #4262) 2019-05-06 18:02:57 +03:00			`"type" : [`
			`"number",`
			`"string"`
			`],`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"docDefault": "Current user gid",`
#3651 fix username undefined 2018-06-03 20:53:09 +02:00			`"docDescription": "Set group id"`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`},`
Add windowsHide option so it can be set via process file, fixes #3425 2018-02-13 11:54:23 -05:00			`"windowsHide": {`
			`"type": "boolean",`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"docDefault": "True",`
			`"docDescription": "Enable or disable the Windows popup when starting an app",`
			`"default": true`
feat: add kill_retry_time argument 2018-03-16 10:07:48 +09:00			`},`
			`"kill_retry_time": {`
			`"type": "number",`
			`"default" : 100`
Merge branch 'development' into master 2018-03-19 09:37:28 +01:00			`},`
add documentation to schema.json 2018-03-15 17:37:01 +01:00			`"write": {`
			`"type": "boolean"`
feature: #3692 allow pm2 to send to pm2-io-apm configuration 2018-06-15 16:59:27 +02:00			`},`
			`"io": {`
			`"type": "object",`
			`"docDescription": "Specify apm values and configuration"`
1. Validate Commander options && JSON key-values and make options briefness and easy configuration. 2. Refactor start/restart 2014-11-24 14:44:20 +08:00			`}`
			`}`