Nodejs教程30（完結）：PM2入門

時間  2019-11-07
標籤 nodejs 教程 完結 pm2 入門 简体版
原文   原文鏈接

閱讀更多系列文章請訪問個人GitHub博客，示例代碼請訪問這裏。

PM2簡介

PM2是經常使用的node進程管理工具，它能夠提供node.js應用管理，如自動重載、性能監控、負載均衡等。同類工具備Supervisor、Forever等。node

PM2安裝

使用PM2須要npm全局安裝。git

npm install -g pm2
複製代碼

啓動PM2項目

本文的測試項目直接選用上一篇完成的項目，地址爲/lesson29/。github

直接啓動項目

pm2支持直接運行server.js啓動項目，以下：正則表達式

pm2 start server.js
複製代碼

便可啓動Node.js應用，成功後會看到打印的信息：npm

[PM2] Spawning PM2 daemon with pm2_home=C:\Users\23101\.pm2
[PM2] PM2 Successfully daemonized
[PM2] Starting C:\xxx\lesson29\server.js in fork_mode (1 instance)
[PM2] Done.
┌────────┬────┬──────┬────────┬───┬─────┬───────────┐
│ Name   │ id │ mode │ status │ ↺ │ cpu │ memory    │
├────────┼────┼──────┼────────┼───┼─────┼───────────┤
│ server │ 0  │ fork │ online │ 0 │ 0%  │ 32.0 MB   │
└────────┴────┴──────┴────────┴───┴─────┴───────────┘
 Use `pm2 show <id|name>` to get more details about an app
複製代碼

在表格中顯示了應用的名稱爲server、id爲0，應用名稱和id均可以做爲該應用的標識。json

經過配置文件管理應用

PM2還支持經過配置文件管理應用，這種方式能夠提供更豐富的配置，支持的配置格式是Javascript，JSON和YAML，具體能夠查看文檔。api

文件夾結構

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配置bash

在Windows中，$ HOME環境變量能夠是$ HOMEDRIVE + $ HOMEPATHapp

查看應用列表

使用命令pm2 list能夠查看應用列表：

┌──────────┬────┬─────────┬──────┬───────┬────────┬─────────┬────────┬─────┬───────────┬───────┬──────────┐
│ App name │ id │ version │ mode │ pid   │ status │ restart │ uptime │ cpu │ mem       │ user  │ watching │
├──────────┼────┼─────────┼──────┼───────┼────────┼─────────┼────────┼─────┼───────────┼───────┼──────────┤
│ server   │ 0  │ 1.0.0   │ fork │ 24776 │ online │ 9       │ 19m    │ 0%  │ 35.4 MB   │ 23101 │ disabled │
└──────────┴────┴─────────┴──────┴───────┴────────┴─────────┴────────┴─────┴───────────┴───────┴──────────┘
複製代碼

查看應用詳情

在命令行中輸入pm2 show 0，彈出信息以下：

Describing process with id 0 - name server 
┌───────────────────┬─────────────────────────────────────────────┐
│ status            │ online                                      │
│ name              │ server                                      │
│ version           │ 1.0.0                                       │
│ restarts          │ 0                                           │
│ uptime            │ 3m                                          │
│ script path       │ C:\xxx\lesson29\server.js                   │
│ script args       │ N/A                                         │
│ error log path    │ C:\Users\23101\.pm2\logs\server-error.log   │
│ out log path      │ C:\Users\23101\.pm2\logs\server-out.log     │
│ pid path          │ C:\Users\23101\.pm2\pids\server-0.pid       │
│ interpreter       │ node                                        │
│ interpreter args  │ N/A                                         │
│ script id         │ 0                                           │
│ exec cwd          │ C:\xxx\lesson29                             │
│ exec mode         │ fork_mode                                   │
│ node.js version   │ 11.9.0                                      │
│ node env          │ N/A                                         │
│ watch & reload    │ ✘                                           │
│ unstable restarts │ 0                                           │
│ created at        │ 2019-04-09T14:07:23.918Z                    │
└───────────────────┴─────────────────────────────────────────────┘
 Revision control metadata 
┌──────────────────┬──────────────────────────────────────────┐
│ revision control │ git                                      │
│ remote url       │ https://github.com/chencl1986/Blog.git   │
│ repository root  │ C:\xxx\Blog                              │
│ last update      │ 2019-04-09T14:07:24.928Z                 │
│ revision         │ 08f1efdfeb48bcc87f96b563d4d013a22e42ed9f │
│ comment          │                                          │
│ branch           │ master                                   │
└──────────────────┴──────────────────────────────────────────┘
 Actions available 
┌────────────────────────┐
│ km:heapdump            │
│ km:cpu:profiling:start │
│ km:cpu:profiling:stop  │
│ km:heap:sampling:start │
│ km:heap:sampling:stop  │
└────────────────────────┘
 Trigger via: pm2 trigger server <action_name>

 Code metrics value 
┌────────────────────────┬───────┐
│ Heap Size              │ 13.70 │
│ Heap Usage             │ 59.91 │
│ Used Heap Size         │ 8.21  │
│ Active requests        │ 0     │
│ Active handles         │ 4     │
│ Event Loop Latency     │ 2.30  │
│ Event Loop Latency p95 │ 7.15  │
│ HTTP Mean Latency      │ 10    │
│ HTTP P95 Latency       │ 10038 │
│ HTTP                   │ 0     │
└────────────────────────┴───────┘
 Add your own code metrics: http://bit.ly/code-metrics
 Use `pm2 logs server [--lines 1000]` to display logs
 Use `pm2 env 0` to display environement variables
 Use `pm2 monit` to monitor CPU and Memory usage server
複製代碼

監控CPU/內存

使用pm2 monit方法，便可監控CPU和內存的使用狀況，同時應用的報錯信息也會打印在Global Logs窗口中，以下：

監聽代碼變化

使用以下命令，能夠監聽代碼保存，並更新應用。

pm2 start server.js --watch
複製代碼

PM2不止監聽server.js文件，還監聽了它引用的全部模塊，只要任意模塊代碼進行了保存，如鍵盤按下ctrl + s，或新建文件，PM2就會進行重啓。

若是須要忽略某些文件，則能夠在配置文件中設置，以下：

{
  "watch": ["server", "client"],
  "ignore_watch" : ["node_modules", "client/img"],
  "watch_options": {
    "followSymlinks": false
  }
}
複製代碼
  • watch能夠是布爾值，路徑數組或表示路徑的字符串。默認爲false。
  • ignore_watch能夠是一個路徑數組或一個字符串，它將被chokidar解釋爲glob或正則表達式。
  • watch_options是一個替代chokidar的選項的對象。有關定義，請參閱chokidar文檔。

環境管理

在項目開發時，一般須要進行環境管理，PM2可使用配置文件與命令行參數設置環境。

添加配置文件

首先，使用pm2 init命令，建立一個ecosystem.config.js文件，其中已經有默認的配置。

module.exports = {
  apps : [{
    name: 'API',
    script: 'app.js',

    // Options reference: https://pm2.io/doc/en/runtime/reference/ecosystem-file/
    args: 'one two',
    instances: 1,
    autorestart: true,
    watch: false,
    max_memory_restart: '1G',
    env: {
      NODE_ENV: 'development'
    },
    env_production: {
      NODE_ENV: 'production'
    }
  }],

  deploy : {
    production : {
      user : 'node',
      host : '212.83.163.1',
      ref  : 'origin/master',
      repo : 'git@github.com:repo.git',
      path : '/var/www/production',
      'post-deploy' : 'npm install && pm2 reload ecosystem.config.js --env production'
    }
  }
};
複製代碼

修改配置

其中，對環境管理有用的爲：

{
  env: {
    NODE_ENV: 'development'
  },
  env_production: {
    NODE_ENV: 'production'
  }
}
複製代碼

爲了配合咱們的項目，能夠將配置修改成以下：

{
  env: {
    NODE_ENV: 'dev'
  },
  env_development: {
    NODE_ENV: 'dev'
  },
  env_production: {
    NODE_ENV: 'prod'
  }
}
複製代碼

他們對應的啓動命令分別爲：

  • pm2 start ecosystem.config.js --watch --env
  • pm2 start ecosystem.config.js --watch --env development
  • pm2 start ecosystem.config.js --watch --env production

啓動開發環境

在服務端的代碼中，能夠經過process.env.NODE_ENV，拿到設置的值。

例如咱們使用pm2 start ecosystem.config.js --watch --env development命令啓動項目，則能夠打印出process.env.NODE_ENV的值爲`dev：

示例代碼：/lesson29/config/index.js

const process = require('process')
console.log(process.env.NODE_ENV) // dev
mode = process.env.NODE_ENV // dev
複製代碼

日誌管理

PM2提供了十分強大的日誌管理功能，支持以多種方式查看日誌。

  1. 以特殊日期格式查看日誌

    # 以特殊日期格式查看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
複製代碼

  2. 以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. 查看近3行日誌

    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
複製代碼

CLI參考

除了上面介紹的命令以外，PM2還有許多其餘實用命令，在此就不一一列舉，有須要的話能夠查看文檔

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程