PM2實用入門指南

最新推荐文章于 2024-01-05 08:57:18 发布
最新推荐文章于 2024-01-05 08:57:18 发布
阅读量152 收藏
点赞数
分类专栏： NODEJS

PM2实用入门指南

简介

PM2是node进程管理工具，可以利用它来简化很多node应用管理的繁琐任务，如性能监控、自动重启、负载均衡等，而且使用非常简单。

下面就对PM2进行入门性的介绍，基本涵盖了PM2的常用的功能和配置。

安装

全局安装，简直不能更简单。

npm install -g pm2

目录介绍

pm2安装好后，会自动创建下面目录。看文件名基本就知道干嘛的了，就不翻译了。

  • $HOME/.pm2 will contain all PM2 related files
  • $HOME/.pm2/logs will contain all applications logs
  • $HOME/.pm2/pids will contain all applications pids
  • $HOME/.pm2/pm2.log PM2 logs
  • $HOME/.pm2/pm2.pid PM2 pid
  • $HOME/.pm2/rpc.sock Socket file for remote commands
  • $HOME/.pm2/pub.sock Socket file for publishable events
  • $HOME/.pm2/conf.js PM2 Configuration

入门教程

挑我们最爱的express应用来举例。一般我们都是通过npm start启动应用，其实就是调用node ./bin/www。那么，换成pm2就是

注意，这里用了--watch参数，意味着当你的express应用代码发生变化时，pm2会帮你重启服务，多贴心。

pm2 start ./bin/www --watch

入门太简单了，没什么好讲的。直接上官方文档：http://pm2.keymetrics.io/docs/usage/quick-start

常用命令

启动

参数说明：

  • --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 start app.js --watch -i 2

重启

pm2 restart app.js

停止

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

pm2 stop app_name|app_id

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

pm2 stop all

删除

类似pm2 stop，如下

pm2 stop app_name|app_id
pm2 stop all

查看进程状态

pm2 list

查看某个进程的信息

[root@iZ94wb7tioqZ pids]# pm2 describe 0
Describing process with id 0 - name oc-server
┌───────────────────┬──────────────────────────────────────────────────────────────┐
│ status            │ online                                                       │
│ name              │ oc-server                                                    │
│ id                │ 0                                                            │
│ path              │ /data/file/qiquan/over_the_counter/server/bin/www            │
│ args              │                                                              │
│ exec cwd          │ /data/file/qiquan/over_the_counter/server                    │
│ error log path    │ /data/file/qiquan/over_the_counter/server/logs/app-err-0.log │
│ out log path      │ /data/file/qiquan/over_the_counter/server/logs/app-out-0.log │
│ pid path          │ /root/.pm2/pids/oc-server-0.pid                              │
│ mode              │ fork_mode                                                    │
│ node v8 arguments │                                                              │
│ watch & reload    │                                                             │
│ interpreter       │ node                                                         │
│ restarts          │ 293                                                          │
│ unstable restarts │ 0                                                            │
│ uptime            │ 87m                                                          │
│ created at        │ 2016-08-26T08:13:43.705Z                                     │
└───────────────────┴──────────────────────────────────────────────────────────────┘

配置文件

简单说明

  • 配置文件里的设置项，跟命令行参数基本是一一对应的。
  • 可以选择yaml或者json文件，就看个人洗好了。
  • json格式的配置文件，pm2当作普通的js文件来处理，所以可以在里面添加注释或者编写代码，这对于动态调整配置很有好处。
  • 如果启动的时候指定了配置文件，那么命令行参数会被忽略。（个别参数除外，比如--env）

例子

举个简单例子，完整配置说明请参考官方文档。

{
  "name"        : "fis-receiver",  // 应用名称
  "script"      : "./bin/www",  // 实际启动脚本
  "cwd"         : "./",  // 当前工作路径
  "watch": [  // 监控变化的目录，一旦变化，自动重启
    "bin",
    "routers"
  ],
  "ignore_watch" : [  // 从监控目录中排除
    "node_modules", 
    "logs",
    "public"
  ],
  "watch_options": {
    "followSymlinks": false
  },
  "error_file" : "./logs/app-err.log",  // 错误日志路径
  "out_file"   : "./logs/app-out.log",  // 普通日志路径
  "env": {
      "NODE_ENV": "production"  // 环境参数，当前指定为生产环境
  }
}

自动重启

前面已经提到了，这里贴命令行，更多点击这里。

pm2 start app.js --watch

这里是监控整个项目的文件，如果只想监听指定文件和目录，建议通过配置文件的watch、ignore_watch字段来设置。

环境切换

在实际项目开发中，我们的应用经常需要在多个环境下部署，比如开发环境、测试环境、生产环境等。在不同环境下，有时候配置项会有差异，比如链接的数据库地址不同等。

对于这种场景，pm2也是可以很好支持的。首先通过在配置文件中通过env_xx来声明不同环境的配置，然后在启动应用时，通过--env参数指定运行的环境。

环境配置声明

首先，在配置文件中，通过env选项声明多个环境配置。简单说明下：

  • env为默认的环境配置（生产环境），env_dev、env_test则分别是开发、测试环境。可以看到，不同环境下的NODE_ENV、REMOTE_ADDR字段的值是不同的。
  • 在应用中，可以通过process.env.REMOTE_ADDR等来读取配置中生命的变量。
  "env": {
    "NODE_ENV": "production",
    "REMOTE_ADDR": "http://www.example.com/"
  },
  "env_dev": {
    "NODE_ENV": "development",
    "REMOTE_ADDR": "http://wdev.example.com/"
  },
  "env_test": {
    "NODE_ENV": "test",
    "REMOTE_ADDR": "http://wtest.example.com/"
  }

启动指明环境

假设通过下面启动脚本（开发环境），那么，此时process.env.REMOTE_ADDR的值就是相应的 http://wdev.example.com/ ，可以自己试验下。

pm2 start app.js --env dev

负载均衡

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

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

参考文档：点击查看

日志查看

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

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

pm2 logs

指令tab补全

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

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

pm2 completion install
source ~/.bash_profile

Alt text

开机自动启动

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

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

传入node args

直接上例子，分别是通过命令行和配置文件。

命令行：

pm2 start app.js --node-args="--harmony"

配置文件：

{
  "name" : "oc-server",
  "script" : "app.js",
  "node_args" : "--harmony"
}

实例说明

假设是在centos下，那么运行如下命令，搞定。强烈建议运行完成之后，重启机器，看是否设置成功。

[root@iZ94wb7tioqZ option_analysis]# pm2 save
[root@iZ94wb7tioqZ option_analysis]# pm2 startup centos
[PM2] Generating system init script in /etc/init.d/pm2-init.sh
[PM2] Making script booting at startup...
[PM2] /var/lock/subsys/pm2-init.sh lockfile has been added
[PM2] -centos- Using the command:
      su -c "chmod +x /etc/init.d/pm2-init.sh; chkconfig --add pm2-init.sh"

[PM2] Done.
[root@iZ94wb7tioqZ option_analysis]# pm2 save
[PM2] Dumping processes

远程部署

可参考官方文档，配置也不复杂，用到的时候再来填写这里的坑。TODO

官方文档：http://pm2.keymetrics.io/docs/usage/deployment/#getting-started

监控(monitor)

运行如下命令，查看当前通过pm2运行的进程的状态。

pm2 monit

看到类似输出

[root@oneday-dev0 server]# pm2 monit
⌬ PM2 monitoring (To go further check out https://app.keymetrics.io) 
                                       [                              ] 0 %
⌬ PM2 monitoring (To go further check o[|||||||||||||||               ] 196.285 MB  

 ● fis-receiver                        [                              ] 0 %
[1] [fork_mode]                        [|||||                         ] 65.773 MB  

 ● www                                 [                              ] 0 %
[2] [fork_mode]                        [|||||                         ] 74.426 MB  

 ● oc-server                           [                              ] 0 %
[3] [fork_mode]                        [||||                          ] 57.801 MB  

 ● pm2-http-interface                  [                              ] stopped
[4] [fork_mode]                        [                              ] 0 B   

 ● start-production
[5] [fork_mode]

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

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

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

更新pm2

官方文档：http://pm2.keymetrics.io/docs/usage/update-pm2/#updating-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;
    }
}

官方文档：http://pm2.keymetrics.io/docs/tutorials/pm2-nginx-production-setup

在线监控系统

收费服务，使用超级简单，可以方便的对进程的服务情况进行监控。可以试用下，地址在这里。

这里贴个项目中试用的截图。

pm2

pm2编程接口

如果想把pm2的进程监控，跟其他自动化流程整合起来，pm2的编程接口就很有用了。细节可参考官方文档：
http://pm2.keymetrics.io/docs/usage/pm2-api/

模块扩展系统

pm2支持第三方扩展，比如常用的log rotate等。可参考官方文档。

写在后面

pm2的文档已经写的很好了，学习成本很低，即使是没用过pm2的小伙伴，基本上照着getting started的例子就可以把项目给跑起来，所以文中不少地方都是建议直接参看官方文档。

yqj234
关注
专栏目录
PM2实用入门指南
Sophie_U的博客
03-31 464
文章目录一、安装1.1 目录介绍1.2 入门教程二、常用命令三、配置文件3.1 简单说明3.2 自动重启3.3 环境切换四、常用操作配置4.1 负载均衡4.2 日志查看4.3 指令tab补全4.4 开机自动启动4.5 传入node args五、 实例说明 PM2是node进程管理工具，可以利用它来简化很多node应用管理的繁琐任务，如性能监控、自动重启、负载均衡等，而且使用非常简单。 转载自博客园 下面就对PM2进行入门性的介绍，基本涵盖了PM2的常用的功能和配置。 一、安装 全局安装，简直不能更简
浅析PM2实用入门指南
青年码农
07-20 810
点击上方“青年码农”关注回复“特效源码”可获取各种资料PM2 是一个守护进程管理器，可以用它来管理你的node进程，负责所有正在运行的进程，并查看node进程的状态，也支持性能监控，负载均衡等功能。使用起来也是非常简单一特性日志管理：收集日志，并有插件配合进行管理负载均衡：减轻服务器压力终端监控：可以在终端中监控您的应用程序并检查应用程序运行状况静态服务：支持静态服务器...
PM2入门及其常用命令
Shawn的个人博客
04-07 6871
进程管理主要是指创建，终止和监控进程。进程管理器主要是用来确保你的应用在启动后能够保持在线pm2 是 nodejs 的进程管理器，默认支持负载均衡，能够守护进程。还支持查看应用运行时的性能，资源占用情况等当我们需要管理多个应用，或者应用有多个运行环境时，使用pm2 start来启动应用＋配置参数是很不方便的。所以，pm2 支持使用配置文件来启动和管理应用。
PM2进程管理器
qq_36801250的博客
05-12 1661
什么是PM2 ？ pm2 是一个带有负载均衡功能的Node应用的进程管理器.当你要把你的独立代码利用全部的服务器上的所有CPU,并保证进程永远都活着,0秒的重载, PM2是完美的,下面我们来看pm2常用的命令用法介绍吧。 PM2 （github上的源码）是开源的基于Nodejs的进程管理器，包括守护进程，监控，日志的一整套完整的功能，基本是Nodejs应用程序不二的守护进程选择，事实上它并不仅仅可以启动Nodejs的程序，只要是一般的脚本的程序它同样可以胜任。 PM2常用命令 假设你现在已经写好了一个app
pm2常用命令汇总
高先生的猫
05-07 8258
pm2是什么 pm2（Process Manager 2）是具有内置负载均衡器的Node.js应用程序的生产运行时和进程管理器。它允许您永久保持应用程序活跃，无需停机即可重新加载它们，并促进常见的Devops任务。 pm2特性 后台运行：普通启动方式：node index.js关闭终端就结束进程，pm2可以后台运行，终端关闭不影响 日志管理：应用程序日志保存在服务器的硬盘中~/.pm2/logs/ 负载均衡：pm2可以通过创建共享同一服务器端口的多个子进程来扩展您的应用程序，这样做还允许您以零秒停
什么是PM2 ---- （零秒重启）
LizequaNNN的博客
08-31 1214
什么是PM2 一、了解PM2 PM2（Process Manager 2 ）是具有内置负载均衡器的Node.js应用程序的生产运行时和进程管理器。 它允许您永久保持应用程序活跃，无需停机即可重新加载它们，并促进常见的Devops任务。 二、PM2的特性 2.1 日志管理：应用程序日志保存在服务器的硬盘中~/.pm2/logs/； 命令行输入：pm2 logs 2.2 集群模式（负载均衡）：具体取决于可用 CPU 的数量，它使用 Node.js集群模块，以便扩展应用程序的子进程可以自动共享服务器端口，ma
PM2实用入门指南 .pdf
11-14
### PM2实用入门指南 #### 一、简介 PM2是一种功能强大的Node.js应用程序进程管理工具，被广泛用于生产环境中管理Node.js应用。通过PM2，开发者能够轻松地实现诸如性能监控、自动重启、负载均衡等功能，从而极大地...
Node进程管理利器：PM2入门教程
"PM2实用入门指南 .pdf" PM2是Node.js应用程序的一个关键工具，它提供了一种高效且便捷的方式来管理和维护Node.js服务。作为一个进程管理器，PM2能够确保应用在服务器上始终运行，即使在发生错误时也能自动重启，...
PM3入门资料教程及工具
04-26
此外，软件部分可能包含PMP备考指南，模拟试题集，以及一些实用的项目管理工具，帮助考生更有效地准备考试。 总之，这个压缩包为PM3的学习提供了全面的支持，从理论知识到实践技能，再到考试准备，覆盖了项目管理的...
pm2基本使用
云创网络工作室官方账号
09-19 8042
全面讲解node管理器pm2的基本使用
一天一个linux命令--pm2
daduryi的博客
11-17 246
描述 pm2是一个进程管理工具,基于node实现. 应用场景同supervisor相同(由python实现). pm2可以在windows上使用! pm2使用热门指南(博客园) 官方文档 安装 npm install -g pm2 参数说明 -watch：监听应用目录的变化，一旦发生变化，自动重启。如果要精确监听、不见听的目录，最好通过配置文件。 -i --instances：启用多少个实例，可...
服务端学习笔记：PM2、Node.js、Koa
anan7410的博客
09-04 1134
严格来说，node不是一门编程语言，而是js的运行环境。Node.js 被设计成单线程运行，但这并不意味着你无法利用到 CPU 的多个核心。你可以通过 child_process.fork() API 来生成子进程，并且它被设计成非常易于通信。而建立在同一个接口之上的 cluster 模块允许你在进程之间共享套接字（sockets），以实现核心的负载均衡。
pm2是一个进程管理工具
木 雨
06-05 642
pm2是一个进程管理工具,可以用它来管理你的node进程，并查看node进程的状态，当然也支持性能监控，进程守护，负载均衡等功能 1、 pm2需要全局安装 npm install -g pm2 2、进入项目根目录 2.1 启动进程/应用 pm2 start bin/www 或 pm2 start app.js 2.2 重命名进程/应用 pm2 start app.js --name wb123 2.3 添加进程/应用 watch pm2 start bin/www --watch 2.4 结束进程/
pm2 start 带参数_pm2配置文件介绍
weixin_39721807的博客
12-22 2152
PM2的优势PM2是一个带有负载均衡功能的Node应用的进程管理！内建负载均衡(使用Node cluster 集群模块)可以在后台运行可以0秒停机重载，(可以理解为不需要停机重启，在用户愉快的浏览页面时我们已经程序更新了)控制台检测日志管理热重载..........在我们的Node项目中实现将以下PM2配置文件于package.json放到一个根目录下在package.json 的scripts里...
pm2 常用命令
fx67ll的博客
04-28 3623
先说一些废话 之前学习Nodejs项目的时候使用了pm2作为生产环境的进程管理工具，最近服务器崩了需要重启一些服务，发现有些命令记得不是特别清楚， 所以这里写一篇文章帮助自己记忆整理一下pm2的常用命令，后续有需要查阅一下即可~ 常用命令 进入bin目录启动：pm2 start www / pm2 start app.js pm2 start app.js --name="fx67ll" 启动并命名为fx67ll，没有命名的话后续可以用id替代name pm2 start app.js --watch 当
Pm2安装以及守护傻妞机器人进程教程
最新发布
blog.jichun29.cn
01-05 429
本教程以centos7为例子，其他系统可自行替换。
【pm2】pm2的安装与基本命令：
SunPeng的博客
02-20 5286
【pm2】pm2的安装与基本命令：
pm2详细使用教程
Sunny王维
07-10 1591
pm2简介 PM2是node进程管理工具，可以利用它来简化很多node应用管理的繁琐任务，如性能监控、自动重启、负载均衡等，而且使用非常简单。 常用命令 安装：npm install pm2 -g 更新：pm2 update 帮助：pm2 --help 进程列表：pm2 ls / pm2 list CPU监控：pm2 monit 显示某个进程详细信息：pm2 show/info/describe/desc 进程名 进程状态：pm2 status 显示所有应用日志：pm2 logs 显示某个应用日志：pm2
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值