PM2 学习笔记

左手的ㄟ右手 2023-01-06 11:36 124阅读 0赞

### PM2 学习笔记 ###

*  安装
 *  PM2常用命令
 *  管理SpringBoot 项目
 *   *  创建脚本 & 运行服务
     *  设置自启动（开机启动）
 *  日志分割
 *  参考资料

**PM2**是**Nodejs**下的进程守护工具，无论**win**还是**linux**它都能帮您实现服务的**7\*24**在线。

# 安装 #

1.  先安装 nodejs 参考：[Nodejs 学习笔记 下载安装][Nodejs _]
2.  全局安装 pm2 ： (会装在`/usr/node/bin/pm2`)

npm install pm2 -g

1.  创建软链接。完成安装

ln -sf /usr/node/bin/pm2 /usr/local/bin/

1.  查看服务列表试试。(虽然列表是空的，但是我们看到命令生效了)

pm2 list

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70]

# PM2常用命令 #

服务名称还可换成：`all`所有服务 、`id` 指定服务、`例：服务名为 sss`

<table> 
 <thead> 
  <tr> 
   <th align="left">参数</th> 
   <th align="left">功能</th> 
   <th align="left">例子</th> 
   <th align="left">别名</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">-h</td> 
   <td align="left">显示帮助信息</td> 
   <td align="left"><code>pm2 -h</code></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">list</td> 
   <td align="left">显示服务列表</td> 
   <td align="left"><code>pm2 list</code></td> 
   <td align="left"><code>ls</code>/<code>l</code>/<code>ps</code>/<code>status</code></td> 
  </tr> 
  <tr> 
   <td align="left">start <font>service-name</font></td> 
   <td align="left">启动服务。支持指定服务名 --name sss666<br><code>备注：第一次启动要写脚本名 sss.json 启动后服务名就注册成功了可以用了。但是平时手动操作用ID更方便？</code></td> 
   <td align="left"><code>pm2 start</code> <strong>sss</strong></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">stop <font>service-name</font></td> 
   <td align="left">停止服务</td> 
   <td align="left"><code>pm2 stop</code> <strong>sss</strong></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">restart <font>service-name</font></td> 
   <td align="left">重启服务</td> 
   <td align="left"><code>pm2 restart</code> <strong>sss</strong></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">reload <font>service-name</font></td> 
   <td align="left">重启服务（热加载）</td> 
   <td align="left"><code>pm2 reload</code> <strong>sss</strong></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">log <font>service-name</font></td> 
   <td align="left">查看日志</td> 
   <td align="left"><code>pm2 log</code> <strong>sss</strong></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">log <font>–lines 500</font></td> 
   <td align="left">查看最新500行</td> 
   <td align="left"><code>pm2 log --lines 500</code> <strong>sss</strong></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">delete <font>service-name</font></td> 
   <td align="left">删除服务 <br><code>备注：修改过启动配置脚本的，要先删再启动才有效。</code></td> 
   <td align="left"><code>pm2 del</code> <strong>sss</strong></td> 
   <td align="left"><code>del</code></td> 
  </tr> 
  <tr> 
   <td align="left">describe <font>service-name</font></td> 
   <td align="left">查看服务详情<br><code>忘记配置文件和jar在哪时非常好用</code></td> 
   <td align="left"><code>describe</code> <strong>sss</strong></td> 
   <td align="left"><code>desc</code>/<code>info</code>/<code>show</code></td> 
  </tr> 
  <tr> 
   <td align="left">-</td> 
   <td align="left">-</td> 
   <td align="left"><font>——————————————</font></td> 
   <td align="left">-</td> 
  </tr> 
  <tr> 
   <td align="left">save</td> 
   <td align="left">保存当前服务列表</td> 
   <td align="left"><code>pm2 save</code></td> 
   <td align="left"><code>expose</code></td> 
  </tr> 
  <tr> 
   <td align="left">startup</td> 
   <td align="left">当前保存的服务列表，设置为自启动</td> 
   <td align="left"><code>pm2 startup</code></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">unstartup</td> 
   <td align="left">取消自启动。<br><code>如果更新了服务的启动脚本，要先停一次再开</code></td> 
   <td align="left"><code>pm2 unstartup</code></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">flush</td> 
   <td align="left">清空所有日志</td> 
   <td align="left"><code>pm2 flush</code></td> 
   <td align="left"></td> 
  </tr> 
 </tbody> 
</table>

# 管理SpringBoot 项目 #

## 创建脚本 & 运行服务 ##

1.  打包`SpringBoot`项目得到jar包`demo.jar`，上传到`/home/demo/demo.jar`
2.  编写配置文件 `demoService.json`，上传到`/home/demo/demoService.json`

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>例</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td><code>"sss"</code></td> 
   <td align="left">启动成功后，此字段的值将注册成为<code>服务名称</code>。（配置文件名和服务名保持一致方便记忆）</td> 
  </tr> 
  <tr> 
   <td>script</td> 
   <td><code>"java"</code></td> 
   <td align="left">要执行的程序，比如<code>java</code>。因为已经在环境变量中，可以直接写</td> 
  </tr> 
  <tr> 
   <td>cwd</td> 
   <td><code>"var/www/"</code></td> 
   <td align="left">the directory from which your app will be launched</td> 
  </tr> 
  <tr> 
   <td>args</td> 
   <td><code>"-jar", "demo.jar" "--server.port=8080"</code></td> 
   <td align="left">程序的运行参考。我们要运行 <code>jar</code> 包</td> 
  </tr> 
  <tr> 
   <td>exec_interpreter</td> 
   <td></td> 
   <td align="left">NodeJs解析器。本项目无视即可</td> 
  </tr> 
  <tr> 
   <td>exec_mode</td> 
   <td><code>fork</code></td> 
   <td align="left">非NodeJs固定写fork</td> 
  </tr> 
  <tr> 
   <td>watch</td> 
   <td><code>true</code></td> 
   <td align="left">为<code>true</code>时，如果配置脚本发生变化，将自动重启。（生产环境不建议使用）</td> 
  </tr> 
  <tr> 
   <td>log_date_format</td> 
   <td><code>"YYYY-MM-DD HH:mm Z"</code></td> 
   <td align="left">日志时间格式。<a href="https://momentjs.com/docs/#/displaying/format/" rel="nofollow">momentjs 日期格式语法</a></td> 
  </tr> 
  <tr> 
   <td>error_file</td> 
   <td></td> 
   <td align="left">错误日志位置。默认：<code>$HOME/.pm2/logs/XXXerr.log</code></td> 
  </tr> 
  <tr> 
   <td>out_file</td> 
   <td></td> 
   <td align="left">信息日志位置。默认：<code>$HOME/.pm2/logs/XXXout.log</code></td> 
  </tr> 
 </tbody> 
</table>

{ 
        "name": "demoService",
        "script": "java",
        "args": [
            "-jar",
            "-Dserver.port=8001",
    		"-D-Xms512m",
    		"-D-Xmx512m",
            "demo.jar"
        ],
        "out_file" : "D:/logs/demo-out.log",
        "error_file" : "D:/logs/demo-err.log",
        "exec_interpreter": "",
        "exec_mode": "fork"
    }

1.  启动服务

pm2 start demoService.json

## 设置自启动（开机启动） ##

1.  生成启动脚本`pm2 startup`

pm2 startup

1.  保存当前服务列表`pm2 save`

[root@iZuf6fu80p2mfzoh619ifjZ ~]# pm2 save
    [PM2] Saving current process list...
    [PM2] Successfully saved in /root/.pm2/dump.pm2

执行成功的会显示信息保存的位置。（感觉我也不会手动去看它吧）

# 日志分割 #

pm2默认无分割日志功能 ，所以需要安装插件：[pm2-logrotate][]

*  安装

pm2 install pm2-logrotate

*  安装完成后，设置参数：

pm2 set pm2-logrotate:<参数> <值>

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>默认值</th> 
   <th align="left">用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>max_size</td> 
   <td><code>10</code>M</td> 
   <td align="left">当一个文件的大小超过这个值时，它将旋转它(它可能是工作人员在它实际超过限制后检查文件)。 在结束时可以指定单位:10G, 10M, 10K</td> 
  </tr> 
  <tr> 
   <td>retain</td> 
   <td><code>30</code>个</td> 
   <td align="left">这个数字是任何时间保存的旋转日志的数量，这意味着如果你有retain = 7，你将最多有7个旋转的日志和你当前的一个。</td> 
  </tr> 
  <tr> 
   <td>compress</td> 
   <td><code>false</code></td> 
   <td align="left">启用通过gzip压缩所有已旋转的日志</td> 
  </tr> 
  <tr> 
   <td>dateFormat</td> 
   <td><code>YYYY-MM-DD_HH-mm-ss</code></td> 
   <td align="left">日志文件名数据的格式</td> 
  </tr> 
  <tr> 
   <td>rotateModule</td> 
   <td><code>true</code></td> 
   <td align="left">像其他应用程序一样旋转pm2模块的日志</td> 
  </tr> 
  <tr> 
   <td>workerInterval</td> 
   <td><code>30</code>秒</td> 
   <td align="left">你可以控制worker检查日志大小的时间间隔(最小值为1)</td> 
  </tr> 
  <tr> 
   <td>rotateInterval</td> 
   <td><code>0 0 * * *</code> 每天午夜</td> 
   <td align="left">这个cron用于执行强制旋转。 我们使用<a href="https://github.com/node-schedule/node-schedule" rel="nofollow">node-schedule</a>来调度cron，因此所有用于<a href="https://github.com/node-schedule/node-schedule" rel="nofollow">node-schedule</a>的有效cron都是此选项的有效cron。 Cron风格:</td> 
  </tr> 
  <tr> 
   <td>TZ</td> 
   <td>系统时间</td> 
   <td align="left">这是标准的<a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" rel="nofollow">TZ数据库时区</a>，用于偏移保存的日志文件。 例如，Etc/GMT+1的值带有每小时的日志，将在格林尼治时间14时保存一个文件，日志名称中包含13时(GMT+1)。</td> 
  </tr> 
 </tbody> 
</table>

*    *    *    *    *    *
    ┬    ┬    ┬    ┬    ┬    ┬
    │    │    │    │    │    |
    │    │    │    │    │    └ day of week (0 - 7) (0 or 7 is Sun)
    │    │    │    │    └───── month (1 - 12)
    │    │    │    └────────── day of month (1 - 31)
    │    │    └─────────────── hour (0 - 23)
    │    └──────────────────── minute (0 - 59)
    └───────────────────────── second (0 - 59, OPTIONAL)

*  配置参考

pm2 set pm2-logrotate:max_size 1K (1KB)
    pm2 set pm2-logrotate:compress true (compress logs when rotated)
    pm2 set pm2-logrotate:rotateInterval '*/1 * * * *' (force rotate every minute)

# 参考资料 #

[PM2 快速入门：quick-start][PM2 _quick-start]  
[PM2自启动脚本生成器：Startup Script Generator][PM2_Startup Script Generator]  
[PM2 Start 配置脚本][PM2 Start]  
[momentjs 日期格式语法][momentjs]  
[日志插件 pm2-logrotate][pm2-logrotate]

[Nodejs _]: https://jerryjin.blog.csdn.net/article/details/112607330
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70]: /images/20221119/32eaee2352374258b6520ddaea4637bf.png
[pm2-logrotate]: https://www.npmjs.com/package/pm2-logrotate
[PM2 _quick-start]: https://pm2.keymetrics.io/docs/usage/quick-start#cheatsheet
[PM2_Startup Script Generator]: https://pm2.keymetrics.io/docs/usage/startup/
[PM2 Start]: https://pm2.keymetrics.io/docs/usage/pm2-api/#programmatic-api
[momentjs]: https://momentjs.com/docs/#/displaying/format/