Node.js 运行时指南

流程

1. 将 nodeshift 添加到应用程序中。

   $ npm install nodeshift --save-dev

2. 将 openshift 和 start 条目添加到 package.json 中的 scripts 部分。

   {
     "name": "myApp",
     "version": "1.0.0",
     "description": "",
     "main": "app.js",
     "scripts": {
       "test": "echo \"Error: no test specified\" && exit 1",
       "openshift": "nodeshift --expose --dockerImage=registry.access.redhat.com/rhscl/ubi8/nodejs-12",
       "start": "node app.js",
       ...
     }
     ...
   }

   openshift 脚本使用 nodeshift 将应用部署到 OpenShift。

   注意

   通用基础镜像和 RHEL 镜像可用于 Node.js。有关镜像名称的更多信息，请参阅 Node.js 发行注记。

3. 可选 ：在 package.json 中添加 files 部分。

   {
     "name": "myApp",
     "version": "1.0.0",
     "description": "",
     "main": "app.js",
     "scripts": {
       ...
     },
     "files": [
       "package.json",
       "app.js"
     ]
     ...
   }

   files 部分告知 nodeshift 部署到 OpenShift 时要包含哪些文件和目录。nodeshift 使用 node-tar 模块根据您在 files 部分列出的文件和目录创建 tar 文件。当 nodeshift 将应用部署到 OpenShift 时，使用此 tar 文件。如果没有指定 files 部分，nodeshift 将发送整个当前目录，不包括：

   • node_modules/
   • .git/

   • tmp/

     建议您在 package.json 中包含 files 部分，以避免在部署到 OpenShift 时包括不必要的文件。

流程

1. 使用 oc 客户端登录您的 OpenShift 实例。

   $ oc login ...

2. 使用 nodeshift 将应用部署到 OpenShift。

   $ npm run openshift

流程

1. 在启用了 debugger 的情况下启动应用。

   原生调试器会自动附加，并提供调试提示。

   启用调试器的示例应用

   $ node inspect app.js
   < Debugger listening on ws://127.0.0.1:9229/12345678-aaaa-bbbb-cccc-0123456789ab
   < For help see https://nodejs.org/en/docs/inspector
   < Debugger attached.
   ...
   debug>

   如果您的应用程序具有不同的入口点，则需要更改命令来指定该入口点：

   $ node inspect path/to/entrypoint

   例如，当使用 express 生成器 创建应用程序时，入口点默认设置为 ./bin/www。

2. 使用 debugger 提示符执行 调试命令。

流程

1. 启动启用了 V8 检查器集成的应用程序。

   $ node --inspect app.js

   如果您的应用程序具有不同的入口点，则需要更改命令来指定该入口点：

   $ node --inspect path/to/entrypoint

   例如，当使用 express 生成器 创建应用程序时，入口点默认设置为 ./bin/www。

2. 附加 V8 检查器并执行调试命令。

   例如，如果使用 Google Chrome：

   1. 导航到 chrome://inspect。
   2. 从以下远程目标 中选择 您的应用程序。
   3. 现在，您可以看到应用程序的源，并可执行调试操作。

流程

1. 使用 oc 命令，列出可用的部署配置：

   $ oc get dc

2. 将应用程序的部署配置中的 NODE_ENV 环境变量设置为 development 以启用调试。例如：

   $ oc set env dc/MY_APP_NAME NODE_ENV=development

3. 如果应用程序没有设置为在配置更改时自动重新部署，请重新部署它。例如：

   $ oc rollout latest dc/MY_APP_NAME

4. 配置从本地机器到应用程序 pod 的端口转发：

   1. 列出当前运行的 pod 并查找包含应用程序的 pod:

      $ oc get pod
      NAME                            READY     STATUS      RESTARTS   AGE
      MY_APP_NAME-3-1xrsp          0/1       Running     0          6s
      ...

   2. 配置端口转发：

      $ oc port-forward MY_APP_NAME-3-1xrsp $LOCAL_PORT_NUMBER:5858

      在这里，$LOCAL_PORT_NUMBER 是您选择的本地机器上未使用的端口号。记住远程调试器配置的这个数字。

5. 附加 V8 检查器并执行调试命令。

   例如，如果使用 Google Chrome：

   1. 导航到 chrome://inspect。
   2. 单击 配置。
   3. 添加 127.0.0.1:$LOCAL_PORT_NUMBER.
   4. 点 Done。
   5. 从以下远程目标 中选择 您的应用程序。
   6. 现在，您可以看到应用程序的源，并可执行调试操作。

6. 完成调试后，取消设置应用程序 pod 中的 NODE_ENV 环境变量。例如：

   $ oc set env dc/MY_APP_NAME NODE_ENV-

流程

1. 添加 debug 日志记录定义。

   const debug = require('debug')('myexample');

2. 添加 debug 语句。

   app.use('/api/greeting', (request, response) => {
     const name = request.query ? request.query.name : undefined;
     //log name in debugging
     debug('name: '+name);
     response.send({content: `Hello, ${name || 'World'}`});
   });

3. 将 debug 模块添加到 package.json。

   ...
   "dependencies": {
       "debug": "^3.1.0"
     }

   根据您的应用程序，可能已经包含此模块。例如，在使用 express 生成器 创建应用程序时，debug 模块已添加到 package.json 中。

4. 安装应用依赖项。

   $ npm install

流程

1. 在启动应用时设置 DEBUG 环境变量以启用调试日志记录。

   $ DEBUG=myexample npm start

   debug 模块 可以使用通配符 来过滤调试消息。这使用 DEBUG 环境变量进行设置。

2. 测试应用来调用调试日志记录。

   例如，以下命令基于示例 REST API 级别 0 应用程序，其中 debug 日志记录被设置为在 /api/greeting 方法中记录 name 变量：

   $ curl http://localhost:8080/api/greeting?name=Sarah

3. 查看应用程序日志以查看您的调试信息。

   myexample name: Sarah +3m

流程

1. 使用 oc CLI 客户端登录 OpenShift 实例。

   $ oc login ...

2. 将应用部署到 OpenShift。

   $ npm run openshift

   此操作运行 openshift npm 脚本，它将嵌套对 nodeshift 的直接调用。

3. 查找 pod 的名称，并按照日志监视它启动。

   $ oc get pods
   ....
   $ oc logs -f pod/POD_NAME

   重要

   pod 启动后，让此命令保持运行，并在新的终端窗口中执行剩余的步骤。这可让您 跟踪 日志并查看组成的新条目。

4. 测试应用。

   例如，以下命令基于示例 REST API 级别 0 应用程序，其中 debug 日志记录被设置为在 /api/greeting 方法中记录 name 变量：

   $ oc get routes
   ...
   $ curl $APPLICATION_ROUTE/api/greeting?name=Sarah

5. 返回到 pod 日志，并注意日志中没有 debug 日志信息。

6. 设置 DEBUG 环境变量以启用调试日志记录。

   $ oc get dc
   ...
   $ oc set env dc DC_NAME DEBUG=myexample

7. 返回到 pod 日志，以观察更新推出。

   推出更新后，您的 Pod 将停止，您将不再遵循日志。

8. 查找新 pod 的名称并按照日志进行操作。

   $ oc get pods
   ....
   $ oc logs -f pod/POD_NAME

   重要

   pod 启动后，让此命令保持运行，并在不同的终端窗口中执行剩余的步骤。这可让您 跟踪 日志并查看组成的新条目。具体来说，日志将显示您的调试信息。

9. 测试应用来调用调试日志记录。

   $ oc get routes
   ...
   $ curl $APPLICATION_ROUTE/api/greeting?name=Sarah

10. 返回到 pod 日志以查看 debug 信息。

    ...
    myexample name: Sarah +3m