美文网首页
pm2---node 进程管理工具

pm2---node 进程管理工具

作者: 大鲨鱼麻吉 | 来源:发表于2019-07-11 17:39 被阅读0次

    node 进程管理工具比较

    • supervisor:是开发环境用,修改命令后重启应用,但是关闭控制台之后,整个进程就挂了
    • forever:管理多个站点,每个站点访问量不大,不需要监控。
    • pm2:网站访问量比较大,需要完整的监控界面。可以后台运行,关闭控制台之后也不影响进程运行。

    PM2 使用介绍:

    P (rocess) M (anager)2

    • PM2 是一个带有负载均衡功能的 Node 应用的进程管理器,利用它来简化很多node应用管理的繁琐任务,如性能监控、自动重启、负载均衡等,而且使用非常简单
    • 当你要把你的独立代码利用全部的服务器上的所有 CPU,并保证进程永远都活着,0 秒的重载, PM2 是完美的。它非常适合 IaaS 结构,但不要把它用于 PaaS 方案(随后将开发 Paas 的解决方案)

    备注:

    • SaaS、PaaS 和 IaaS 是云服务模式
    • SaaS 软件即服务,例如 Google 的 Gmail 邮箱服务,面向应用型用户
    • PaaS 平台即服务,例如 Google 的 GAE,面向开发型用户
    • IaaS 基础架构即服务,例如亚马逊的 AWS,IaaS 对于不知道新推出的应用程序/网站会有多成功的创业公司来说非常有用
    • 参考文档 通俗易懂版本

    PM2的主要特性:

    • 内建负载均衡(使用Node cluster 集群模块)
    • 后台运行
    • 0秒停机重载,我理解大概意思是维护升级的时候不需要停机.?
    • 具有Ubuntu和CentOS 的启动脚本
    • 停止不稳定的进程(避免无限循环)
    • 控制台检测
    • 提供 HTTP API
    • 远程控制和实时的接口API ( Nodejs 模块,允许和PM2进程管理器交互 )

    准备工作-Express 项目创建 并启动服务:

    * express -e pm2-demo
    * npm install
    * npm start
    

    安装

    `npm install -g 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
    

    用法

    $ npm install pm2 -g     # 命令行安装 pm2
    $ pm2 start app.js -i 4  # 后台运行pm2,启动4个app.js
                             # 也可以把'max' 参数传递给 start
                             # 正确的进程数目依赖于Cpu的核心数目
    $ pm2 start app.js --name my-api # 命名进程
    $ pm2 list               # 显示所有进程状态
    $ pm2 monit              # 监视所有进程
    $ pm2 logs               # 显示所有进程日志
    $ pm2 stop all           # 停止所有进程
    $ pm2 restart all        # 重启所有进程
    $ pm2 reload all         # 0 秒停机重载进程 (用于 NETWORKED 进程)
    $ pm2 stop 0             # 停止指定的进程
    $ pm2 restart 0          # 重启指定的进程
    $ pm2 startup            # 产生 init 脚本 保持进程活着
    $ pm2 web                # 运行健壮的 computer API endpoint (http://localhost:9615)
    $ pm2 delete 0           # 杀死指定的进程
    $ pm2 delete all         # 杀死全部进程
    

    运行进程的不同方式

    $ pm2 start app.js -i max    # 根据有效CPU数目启动最大进程数目
    $ pm2 start app.js -i 3      # 启动3个进程
    $ pm2 start app.js -x        #用fork模式启动 app.js 而不是使用 cluster
    $ pm2 start app.js -x -- -a 23   # 用fork模式启动 app.js 并且传递参数 (-a 23)
    $ pm2 start app.js --name serverone  # 启动一个进程并把它命名为 serverone
    $ pm2 stop serverone       # 停止 serverone 进程
    $ pm2 start app.json        # 启动进程, 在 app.json里设置选项
    $ pm2 start app.js -i max -- -a 23                   #在--之后给 app.js 传递参数
    $ pm2 start app.js -i max -e err.log -o out.log  # 启动 并 生成一个配置文件
    你也可以执行用其他语言编写的app  ( fork 模式):
    $ pm2 start my-bash-script.sh    -x --interpreter bash
    $ pm2 start my-python-script.py -x --interpreter python
    
    

    0 秒停机重载:这项功能允许你重新载入代码而不用失去请求连接

    注意:

    • 仅能用于 web 应用
    • 运行于 Node 0.11.x 版本
    • 运行于 fork 模式(默认模式)

    常用命令

    启动

    参数说明:

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

    完整命令行参数列表:地址

    • pm2 start app.js --watch -i 2

    pm2的fork启动模式和cluster模式的区别

    参考文档 文档最后

    重启

    • pm2 restart app.js

    停止

    停止特定的应用。可以先通过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 list

    查看某个进程的信息

    • pm2 describe 0

    配置文件

    简单说明

    • 配置文件里的设置项,跟命令行参数基本是一一对应的。
    • 可以选择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"            // 环境变量,object类型,如{"NODE_ENV":"production", "ID": "42"};
        },
        "instances" : "max",                    // 开启进程数,可为数值,也可为max。与服务器cpu核数相关。应用启动实例个数,仅在cluster模式有效,默认为fork;
        "exec_mode" : "cluster"                 // 应用启动模式,支持fork和cluster模式;cluster(多核推荐)
        "min_uptime": "60s",                    // 应用运行少于时间被认为是异常启动;
        "max_restarts": 30,                     // 最大异常重启次数,即小于min_uptime运行时间重启次数;
        "max_memory_restart": "300M",           // 最大内存限制数,超出自动重启;
        "autorestart": true,                    // 默认为true, 发生异常的情况下自动重启;
    }
    

    例子

    • 举个简单例子,完整配置说明请参考官方文档。 自定义启动文件,创建一个test.json的示例文件,格式如下:
        {
          "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"  // 环境参数,当前指定为生产环境
          }
        }
    

    参数说明

    apps:json结构,apps是一个数组,每一个数组成员就是对应一个pm2中运行的应用

    name:应用程序的名称

    cwd:应用程序所在的目录

    script:应用程序的脚本路径

    exec_interpreter:应用程序的脚本类型,这里使用的shell,默认是nodejs

    minuptime:最小运行时间,这里设置的是60s即如果应用程序在60s内退出,pm2会认为程序异常退出,此时触发重启maxrestarts设置数量

    autorestart 默认为true, 发生异常的情况下自动重启;

    max_restarts:设置应用程序异常退出重启的次数,默认15次(从0开始计数)

    exec_mode:应用程序启动模式,这里设置的是cluster(集群),默认是fork

    error_file:自定义应用程序的错误日志文件

    out_file:自定义应用程序日志文件

    pid_file:自定义应用程序的pid文件

    watch:是否启用监控模式,默认是false。如果设置成true,当应用程序变动时,pm2会自动重载。这里也可以设置你要监控的文件。

    maxmemoryrestart:当内存超过设置的数量时自动重启。 如果工程中有比较棘手的内存泄露问题,这个算是一个折中方案。

    instances: 启用多少个实例,可用于负载均衡。仅在cluster模式有效,默认为fork; cron_restart crontab时间格式,定时重启应用,目前只支持cluster模式;

    自动重启

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

    pm2 start app.js --watch

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

    环境切换

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

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

    环境配置声明

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

    • env为默认的环境配置(生产环境),envdev、envtest则分别是开发、测试环境。可以看到,不同环境下的NODEENV、REMOTEADDR字段的值是不同的。
    • 在应用中,可以通过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
    

    开机自动启动

    可以通过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

    监控(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

    官方文档

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

    Web API

    如果你不仅仅想监控被pm2管理的进程,还需要监控进程所运行的机器的信息,你可以使用下面这个API

    $ pm2 web

    pm2会启动一个叫做pm2-http-interface的进程提供web服务。你打开浏览器输入http://127.0.0.1:9615,是不是被看到的结果惊艳到了。

    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等。可参考官方文档

    参考文档

    NodeJs之pm2

    官网

    pm2进程管理工具使用总结

    node 版本管理工具nvm

    相关文章

      网友评论

          本文标题:pm2---node 进程管理工具

          本文链接:https://www.haomeiwen.com/subject/ynadkctx.html