安装 Node.js Agent

请按照以下说明安装 APM Insight Node.js Agent。

• Node.js Agent 4.x 及以上版本的安装步骤
• Node.js Agent 2.x 和 3.x 版本的安装步骤

视频

以下是关于如何安装 Site24x7 APM Insight Node.js Agent 的快速演示视频。

Node.js Agent 4.x 及以上版本的安装步骤

1. 打开您的 Node.js 应用。
2. 访问 node 包管理器（NPM）。
3. 使用命令 npm i apminsight --save 从 NPM 安装 APM Insight Node.js Agent。这将在 node_modules 下创建一个名为 apminsight 的目录。
4. 您可以选择创建文件并添加配置值，或将配置值设置为环境变量。
   

   • 创建文件并添加配置值

     创建一个名为 apminsightnode.json 的新文件，并将其放置在运行应用的目录中。将以下代码片段添加到文件中。
     

     {
         "licenseKey": "license-key",
         "appName": "application-name",
         "port": "application-port"
     }

     如果您使用代理，请添加以下代码片段：

     {
         "licenseKey": "license-key",
         "appName": "application-name",
         "port": "application-port",
         "proxyServerHost": "proxy-server",
         "proxyServerPort": "proxy-port",
         "proxyAuthUser": "proxy-user-name",
         "proxyAuthPassword": "proxy-password"
     }

   • 将配置值设置为环境变量

     您可以使用以下键将配置值设置为环境变量：
     • licenseKey - APMINSIGHT_LICENSE_KEY
     • appName - APMINSIGHT_APP_NAME
     • port - APMINSIGHT_APP_PORT
     • proxyServerHost - APMINSIGHT_PROXYSERVER_HOST
     • proxyServerPort - APMINSIGHT_PROXYSERVER_PORT
     • proxyAuthUser - APMINSIGHT_PROXYAUTH_USER
     • proxyAuthPassword - APMINSIGHT_PROXYAUTH_PASSWORD
       
       
5. 在 Node.js 应用启动文件的第一行（所有其他 require 语句之前）添加以下代码。
   

   JavaScript	代码片段
   Common JS	require('apminsight');
   ECMAScript	import apminsight from 'apminsight';
   TypeScript	import AgentAPI from apminsight'; AgentAPI.config();

   其他方法
   您也可以选择以下任意一种方法，这些方法适用于所有 JavaScript 类型。

   • 使用环境变量：
     export NODE_OPTIONS="-r apminsight"
   • 在启动脚本或启动应用时加入 require 语句。
     node -r apminsight my-start-file.js
   注意

   -r 用于在启动时预加载指定模块（此处为 apminsight 模块）。
   只有 CommonJS 模块支持 -r。若要预加载 TypeScript 或 ECMAScript 模块，请使用 --import。

6. 可选：您可以在 Windows 和 Linux 上安装 S247DataExporter，可通过以下任一方式进行设置：

   • 通过以下方式启用 S247DataExporter：
     • apminsightnode.json 文件：dataExporterEnabled - 'true'
     • 环境变量（env）：APMINSIGHT_DATA_EXPORTER_ENABLED - 'true'
   • 在以下位置为 S247DataExporter 的主机、状态端口和数据端口设置自定义配置： 
     • apminsightnode.json 文件： 

       dataExporterHost - String

       dataExporterDataPort - Int

       dataExporterStatusPort - Int

     • 环境变量（env）：

       APMINSIGHT_DATA_EXPORTER_HOST - String

       APM_EXPORTER_DATA_PORT - Int

       APM_EXPORTER_STATUS_PORT - Int

   以下是默认配置：

   变量	默认值
   Host	localhost
   DataPort	20022
   StatusPort	20021

   示例：

   //apminsightnode.json
   {  
   ...
   "dataExporterHost": "localhost",
   "dataExporterStatusPort": "20021",
   "dataExporterDataPort": "2022"
   ...
   }

7. 最后，重启应用并执行一些事务，即可在 Web 客户端中查看数据。

APM Insight Node.js 2.x 和 3.x 版本

我们强烈建议您下载最新版本的 APM Insight Node.js Agent。但如果您出于某种原因需要下载 v2.x 或 v3.x 版本的 Agent，请参阅此 知识库文章。