newrelic/synthetics-node-api-runtime

synthetics-node-api-runtime 镜像文档

镜像概述和主要用途

synthetics-node-api-runtime 是一个预配置的Node.js运行时环境，专为合成监控（Synthetic Monitoring）API脚本设计。该镜像封装了稳定的Node.js环境及合成监控所需的核心依赖，旨在简化API监控任务的部署流程，使用户无需手动配置Node.js环境和依赖，即可快速部署并执行API性能、可用性监控脚本。

核心功能和特性

• 预配置Node.js环境：内置指定版本的Node.js运行时，确保脚本执行环境一致性。
• 合成监控依赖集成：预安装合成监控常用依赖（如axios、node-fetch等HTTP客户端，moment时间处理库），无需额外安装。
• 轻量级设计：基于Alpine Linux构建，镜像体积小，资源占用低，适合容器化部署。
• 自定义脚本支持：支持挂载用户自定义监控脚本，灵活适配不同API监控需求。
• 标准化日志输出：集成日志格式化工具，输出结构化监控日志（如响应时间、状态码、错误信息），便于日志收集和分析。

使用场景和适用范围

适用场景

• API端点性能监控：定期执行脚本检测API响应时间、吞吐量。
• API可用性监控：监控API端点是否正常响应（状态码2xx/3xx），及时发现服务不可用问题。
• 自动化监控任务：替代手动执行监控脚本，实现7x24小时持续监控。
• 监控脚本测试：开发阶段快速验证监控脚本逻辑和执行效果。

适用范围

• DevOps团队：部署至Kubernetes、Docker Swarm等容器编排平台，集成到CI/CD流程中。
• SRE团队：用于服务健康状态监控，配置告警规则响应异常。
• 开发人员：本地测试API监控脚本，确保监控逻辑正确性。

使用方法和配置说明

基本使用（Docker Run）

通过docker run命令快速启动监控容器，挂载自定义脚本目录并配置环境变量：

bash
docker run -d \
  --name synthetics-api-monitor \
  -v /path/to/your/scripts:/app/scripts \  # 挂载本地脚本目录到容器内
  -e API_SCRIPT="monitor.js" \             # 指定要执行的监控脚本文件名（位于/app/scripts下）
  -e MONITOR_INTERVAL=60 \                 # 监控间隔（秒，默认60）
  -e LOG_LEVEL="info" \                    # 日志级别（默认info，可选debug/warn/error）
  synthetics-node-api-runtime

Docker Compose配置示例

创建docker-compose.yml文件，定义服务配置：

yaml
version: '3.8'
services:
  api-monitor:
    image: synthetics-node-api-runtime
    container_name: api-monitor
    volumes:
      - ./scripts:/app/scripts  # 本地脚本目录（存放monitor.js等文件）
    environment:
      - API_SCRIPT: "payment-api-monitor.js"  # 自定义监控脚本
      - MONITOR_INTERVAL: 30                  # 每30秒执行一次
      - TIMEOUT: 5000                         # API请求超时时间（毫秒，默认5000）
      - TARGET_API_URL: "https://api.example.com/payment"  # 目标API端点（可在脚本中读取）
    restart: always  # 容器异常退出后自动重启

启动服务：

bash
docker-compose up -d

环境变量配置

自定义监控脚本规范

挂载的脚本需遵循以下规范，以确保容器正常执行：

1. 脚本需导出一个默认异步函数，接收环境变量配置作为参数：

   javascript
   // /path/to/your/scripts/monitor.js 示例
   module.exports = async (config) => {
     const { TARGET_API_URL, TIMEOUT } = config; // 从环境变量获取配置
     const startTime = Date.now();
     
     try {
       const response = await fetch(TARGET_API_URL, { timeout: TIMEOUT });
       const responseTime = Date.now() - startTime;
       
       // 输出结构化日志（容器会自动收集）
       console.log(JSON.stringify({
         timestamp: new Date().toISOString(),
         url: TARGET_API_URL,
         status: response.status,
         responseTime: `${responseTime}ms`,
         status: "success"
       }));
     } catch (error) {
       console.log(JSON.stringify({
         timestamp: new Date().toISOString(),
         url: TARGET_API_URL,
         error: error.message,
         status: "failed"
       }));
     }
   };
   

2. 脚本需放置在挂载目录（如./scripts）中，容器启动时通过API_SCRIPT环境变量指定文件名。

日志查看

容器日志默认输出至标准输出（stdout），可通过docker logs命令查看：

bash
docker logs -f api-monitor  # 实时查看日志（-f 跟随输出）

若需持久化日志，可配置日志驱动（如json-file、journald）或集成ELK、Promtail等日志收集工具。