Jenkins 远程启动nodejs失败,使用pm2守护Nodejs
一、概述
使用Jenkins 远程ssh到linux,使用命令:
ssh root@192.168.10.1 'cd /data/test;nohup npm start &'
发现linux服务器的node进程没有启动。但是本地执行命令:
cd /data/test;nohup npm start &
是可以启动的。
具体原因,参考链接:
https://www.cnblogs.com/zhenbianshu/p/7152327.html
大致意思是,如果远程执行的命令,不是守护进程。即使加了nohup,关闭ssh连接后,当前用户启动的进程会全部终止。
因此,远程执行的命令,必须是守护进程才行。
二、pm2守护Nodejs
简介
pm2是nodejs的一个带有负载均衡功能的应用进程管理器的模块,类似有Supervisor,forever,用来进行进程管理。
安装
npm install pm2 -g
启动
pm2 start app.js pm2 start app.js --name my-api #my-api为PM2进程名称 pm2 start app.js -i 0 #根据CPU核数启动进程个数 pm2 start app.js --watch #实时监控app.js的方式启动,当app.js文件有变动时,pm2会自动reload
查看进程
pm2 list pm2 show 0 或者 # pm2 info 0 #查看进程详细信息,0为PM2进程id
停止
pm2 stop all #停止PM2列表中所有的进程 pm2 stop 0 #停止PM2列表中进程为0的进程
更多pm2命令,请参考链接:
https://www.jianshu.com/p/eb98e639f41e
三、pm2启动脚本
由于公司的Nodejs项目,比如test,它有4个服务,因此有4个app.js。
在package.json里面,有定义启动命令。比如:
"start:client": "cd ./client && npm start",
由于package.json里面有定义一些关联启动命令,因此直接用pm2启动4个app.js,会导致应用异常。
json格式
pm2 start npm -- start这条命令是pm2的万能命令,pm2 start ,就是这一系列命令中的最豪华命令。这个json我们可以理解为一个任务参数描述文件。通过这个json文件,我们把在命令行里面不好描述的各种参数放到一个json文件里面来
pm2 start <json>.json
pm2 start命令中的json格式详解
最精简版本
{ "name": "manage", //项目名称 "script": "./bin/www", //要执行的脚本 "cwd":"./", //项目所在目录 }
执行shell文件版本
{ "name": "manage", //项目名称 "script": "./bin/www.sh", //要执行的脚本 "cwd":"./", //项目所在目录 "exec_interpreter": "bash", }
实战例子demo
下面的test.json是公司项目
{ "apps": [{ "name": "test", //项目名称 "script": "test.sh", //要执行的脚本 "cwd": "/opt/script/", //脚本所在目录 "exec_interpreter": "bash", //应用程序的脚本类型 "exec_mode": "fork", "max_memory_restart": "1G", "autorestart": true, "node_args": [], "args": [], "env": { } }] }
说明:
- apps:json结构,apps是一个数组,每一个数组成员就是对应一个pm2中运行的应用
- name:应用程序名称
- cwd:应用程序所在的目录
- script:应用程序的脚本路径
- log_date_format:
- error_file:自定义应用程序的错误日志文件
- out_file:自定义应用程序日志文件
- pid_file:自定义应用程序的pid文件
- instances:
- min_uptime:最小运行时间,这里设置的是60s即如果应用程序在60s内退出,pm2会认为程序异常退出,此时触发重启max_restarts设置数量
- max_restarts:设置应用程序异常退出重启的次数,默认15次(从0开始计数)
- cron_restart:定时启动,解决重启能解决的问题
- watch:是否启用监控模式,默认是false。如果设置成true,当应用程序变动时,pm2会自动重载。这里也可以设置你要监控的文件。
- merge_logs:
- exec_interpreter:应用程序的脚本类型,这里使用的shell,默认是nodejs
- exec_mode:应用程序启动模式,这里设置的是cluster_mode(集群),默认是fork
- autorestart:启用/禁用应用程序崩溃或退出时自动重启
- vizion:启用/禁用vizion特性(版本控制)
test.sh
#!/bin/bash PROJECT_HOME=/data/test source /etc/profile && cd $PROJECT_HOME;nohup /usr/bin/npm start &
当然,pm2的参数还有很多很多很多,这里仅仅是个范例demo,更多的参数可以点击这里,查看官方文档。
http://pm2.keymetrics.io/docs/usage/cluster-mode/
注意:当nodejs进程停止时,pm2会自动启动进程。
本文参考链接:
https://newsn.net/say/pm2-start-json.html