PM2 Node 应用进程管理器入门

PM2简介

PM2是常用的node进程管理工具,它可以提供node.js应用管理,如自动重载、性能监控、负载均衡等。同类工具有Supervisor、Forever等。

pm2是一个进程管理工具,可以用它来管理你的node进程,并查看node进程的状态,当然也支持性能监控,进程守护,负载均衡等功能。pm2基本是Nodejs应用程序不二的守护进程选择,事实上它并不仅仅可以启动Nodejs的程序,只要是一般的脚本的程序它同样可以胜任。

pm2的主要特性

  • 内建负载均衡(使用node cluster集群模块,可以使用服务器上的所有cpu)
  • 后台运行(node app.js 这种命令是直接在前台运行的,不稳定,很容易断)
  • 0秒停机重载(应该是上线升级的时候 不需要停机)
  • 停止不稳定的进程(避免无限循环)
  • 控制台检测

PM2安装

使用PM2需要npm全局安装。

npm install -g pm2

启动PM2项目

直接启动项目

参数说明:

  • --watch:监听应用目录的变化,一旦发生变化,自动重启。如果要精确监听、不见听的目录,最好通过配置文件。
  • -i --instances:启用多少个实例,可用于负载均衡。如果-i 0或者-i max,则根据当前机器核数确定实例数目。
  • --ignore-watch:排除监听的目录/文件,可以是特定的文件名,也可以是正则。比如--ignore-watch="test node_modules "some scripts""
  • -n --name:应用的名称。查看应用信息的时候可以用到。
  • -o --output <path>:标准输出日志文件的路径。
  • -e --error <path>:错误输出日志文件的路径。
  • --interpreter <interpreter>:the interpreter pm2 should use for executing app (bash, python...)。比如你用的coffee script来编写应用。

pm2支持直接运行Node.js启动项目,如下:

pm2 start server/index.js

即可启动Node.js应用,成功后会看到打印的信息:

在表格中显示了应用的名称为server、id为0,应用名称和id都可以作为该应用的标识。

  • (1)其中app name 和id都是这个进程的标识,可以对他们进行别的操作,比如stop,delete等。
  • (2)mode:进程模式,cluster或fork。cluster有多个进程,而fork只有一个。
  • (3)status:进程是否在线
  • (4)restart:重启次数
  • (5)uptime:运行时间
  • (6)cpu:cpu占用率
  • (7)mem:内存占用大小

通过配置文件管理应用

PM2还支持通过配置文件管理应用,这种方式可以提供更丰富的配置,支持的配置格式是Javascript,JSON和YAML,具体可以查看文档

文件夹结构

PM2启动后,它将自动创建这些文件夹:

  • $HOME/.pm2:将包含所有PM2相关文件
  • $HOME/.pm2/logs:将包含所有应用程序日志
  • $HOME/.pm2/pids:将包含所有应用程序pids
  • $HOME/.pm2/pm2.log:PM2 日志
  • $HOME/.pm2/pm2.pid:PM2 pid
  • $HOME/.pm2/rpc.sock:远程命令的套接字文件
  • $HOME/.pm2/pub.sock:可发布事件的套接字文件
  • $HOME/.pm2/conf.js:PM2配置

在Windows中,HOME环境变量可以是 HOMEDRIVE + $ HOMEPATH

查看应用列表(查看当前机器执行的所有进程)

pm2 list/ls/l

查看某个应用详情(查看某个进程信息)

查看当前机器上id为1的应用的详情

pm2 show app_name|app_id

或者

pm2 describe app_name|app_id

例如:

pm2 show 1

每个参数信息参考:
第一表是指进程的信息,比如status(状态)、restarts(重启次数)、uptime(运行时间)、script path(启动入口的路径)、script args(启动文件的参数)、error log path(错误日志的路径)、out log path(输出日志的路径)、exec mode(进程的模式)、watch&reload(是否开启监听文件变动重启)、unstable restarts(不稳定的重启次数)、heap size(堆内存)、heap usage(堆内存使用率)、used heap size(堆内存使用情况)、event loop latency(事件循环时延)、event loop latency p95(事件循环时延 第95分位)

重启

pm2 restart app.js

或者

pm2 restart app_name|app_name

例如:

pm2 restart 21

停止

停止特定的应用。可以先通过pm2 list获取应用的名字(--name指定的)或者进程id。

pm2 stop app_name|app_id

如果要停止所有应用,可以

pm2 stop all

删除

类似pm2 stop,如下

pm2 delete app_name|app_id
pm2 delete all

日志查看

除了可以打开日志文件查看日志外,还可以通过pm2 logs来查看实时日志。这点对于线上问题排查非常重要。

比如某个node服务突然异常重启了,那么可以通过pm2提供的日志工具来查看实时日志,看是不是脚本出错之类导致的异常重启。

查看指定应用程序日志:

pm2 logs app_name|app_id

例如:

pm2 logs 1

显示所有应用程序的日志:

pm2 logs

另外PM2提供了十分强大的日志管理功能,支持以多种方式查看日志。

  • 以特殊日期格式查看日志

    # 以特殊日期格式查看server应用的日志
    pm2 logs server --format
    

    结果如下:

    timestamp=2019-04-10-23:13:25+0800 app=server id=0 type=out message=dev
    timestamp=2019-04-10-23:13:26+0800 app=server id=0 type=out message=Server started at 8080
    
  • 以JSON格式查看日志

    pm2 logs server --json
    

    结果如下:

    {"timestamp":"2019-04-10T15:14:52.376Z","type":"process_event","status":"exit","app_name":"server"}
    {"timestamp":"2019-04-10T15:14:52.479Z","type":"process_event","status":"exit","app_name":"server"}
    {"message":"dev","timestamp":"2019-04-10T15:14:53.246Z","type":"out","process_id":0,"app_name":"server"}
    {"timestamp":"2019-04-10T15:14:53.284Z","type":"process_event","status":"online","app_name":"server"}
    {"message":"Server started at 8080","timestamp":"2019-04-10T15:14:53.474Z","type":"out","process_id":0,"app_name":"server"}
    
  • 查看近3行日志

    pm2 logs server --lines --raw
    
    例如:
    
    pm2 logs server --lines 3
    

    结果如下:

    [TAILING] Tailing last 3 lines for [server] process (change the value with --lines option)
    C:\xxx\.pm2\logs\server-error.log last 3 lines:
    0|server   |   code: 'ETIMEDOUT',
    0|server   |   syscall: 'connect',
    0|server   |   fatal: true }
    
    C:\xxx\.pm2\logs\server-out.log last 3 lines:
    0|server   | Server started at 8080
    0|server   | dev
    0|server   | Server started at 8080
    

指令tab补全

运行pm2 --help,可以看到pm2支持的子命令还是蛮多的,这个时候,自动完成的功能就很重要了。

运行如下命令。恭喜,已经能够通过tab自动补全了。细节可参考这里

pm2 completion install
source ~/.bash_profile

负载均衡

命令如下,表示开启三个进程。如果-i 0,则会根据机器当前核数自动开启尽可能多的进程。

pm2 start app.js -i 3 # 开启三个进程
pm2 start app.js -i max # 根据机器CPU核数,开启对应数目的进程 

参考文档:点击查看

开机自动启动

可以通过pm2 startup来实现开机自启动。细节可参考。大致流程如下

  • 通过pm2 save保存当前进程状态。
  • 通过pm2 startup [platform]生成开机自启动的命令。(记得查看控制台输出)
  • 将步骤2生成的命令,粘贴到控制台进行,搞定。

监控CPU/内存

运行如下命令,查看当前通过pm2运行的进程的状态。即可监控CPU和内存的使用情况,同时应用的报错信息也会打印在Global Logs窗口中,如下:

pm2 monit

内存使用超过上限自动重启

如果想要你的应用,在超过使用内存上限后自动重启,那么可以加上--max-memory-restart参数。(有对应的配置项)

pm2 start big-array.js --max-memory-restart 20M

更新pm2

官方文档

$ pm2 save # 记得保存进程状态
$ npm install pm2 -g
$ pm2 update

pm2 + nginx

无非就是在nginx上做个反向代理配置,直接贴配置。

upstream my_nodejs_upstream {
    server 127.0.0.1:3001;
}

server {
    listen 80;
    server_name my_nodejs_server;
    root /home/www/project_root;
    
    location / {
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-NginX-Proxy true;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_max_temp_file_size 0;
        proxy_pass http://my_nodejs_upstream/;
        proxy_redirect off;
        proxy_read_timeout 240s;
    }
}

官方文档

pm2编程接口

如果想把pm2的进程监控,跟其他自动化流程整合起来,pm2的编程接口就很有用了。细节可参考官方文档

模块扩展系统

pm2支持第三方扩展,嵌入了一个简单而强大的模块系统。

安装模块很简单:比如常用的log rotate等。可参考官方文档

 pm2 install <module_name>

保存/冻结进程

在重新启动时保存/冻结进程列表

pm2 save

监听代码变化/自动重启

可以监听代码保存,并更新应用

pm2 start app.js --watch

PM2不止监听app.js文件,还监听了它引用的所有模块,只要任意模块代码进行了保存,如键盘按下ctrl + s,或新建文件,PM2就会进行重启。 如果只想监听指定文件和目录,建议通过配置文件的watchignore_watch字段来设置。

如果需要忽略某些文件,则可以在配置文件中设置,如下:

{
  "watch": ["server", "client"],
  "ignore_watch" : ["node_modules", "client/img"],
  "watch_options": {
    "followSymlinks": false
  }
}
  • watch可以是布尔值,路径数组或表示路径的字符串。默认为false。
  • ignore_watch可以是一个路径数组或一个字符串,它将被chokidar解释为glob或正则表达式。
  • watch_options是一个替代chokidar的选项的对象。有关定义,请参阅chokidar文档
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,295评论 6 512
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,928评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,682评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,209评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,237评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,965评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,586评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,487评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,016评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,136评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,271评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,948评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,619评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,139评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,252评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,598评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,267评论 2 358

推荐阅读更多精彩内容

  • pm2是node的进程管理器,它的最大好处是能管理多个node服务,系统重启后或文件修改后,都能重启node服务。...
    随风飘_c165阅读 1,425评论 0 0
  • 简介 PM2是node进程管理工具,可以利用它来简化很多node应用管理的繁琐任务,如性能监控、自动重启、负载均衡...
    中v中阅读 1,266评论 0 0
  • 来源:https://www.cnblogs.com/chyingp/p/pm2-documentation.ht...
    Allen_Ezail_Ive阅读 207评论 0 0
  • 博客地址:http://blog.poetries.top/2018/11/18/react-ssr-next-d...
    程序员poetry阅读 7,387评论 6 7
  • 背景 1. 进程管理 进程管理主要是指创建,终止和监控进程。进程管理器主要是用来确保你的应用在启动后能够保持在线。...
    twentyshaw阅读 2,986评论 0 4