mondaycom/ns1-prometheus-exporter

ns1-prometheus-exporter

镜像概述和主要用途

ns1-prometheus-exporter是一个非官方的简单网关应用，用于通过OpenMetrics格式暴露NS1的每分钟查询指标。它作为HTTP代理应用运行，监听/metrics HTTP端点，调用NS1 API并返回可直接被Prometheus抓取的指标数据。

核心功能和特性

• HTTP代理服务：监听指定端口的/metrics端点，提供Prometheus可抓取的指标
• NS1 API集成：通过NS1 API获取查询数据并转换为OpenMetrics格式
• 数据缓存：API查询结果缓存1分钟，避免过度外部调用
• 多粒度监控：支持记录级（record-level）和区域级（zone-level）两种指标粒度
  • 记录级：按具体DNS记录（如CNAME、MX等）展示每分钟查询数
  • 区域级：展示整个DNS区域的累计每分钟查询数

使用场景和适用范围

适用于需要通过Prometheus监控NS1 DNS服务查询指标的场景，特别适合：

• 需要监控特定DNS区域或记录查询量的用户
• 构建NS1 DNS服务监控仪表盘的DevOps团队
• 希望将NS1指标整合到现有Prometheus监控体系中的组织

详细使用方法和配置说明

快速开始

本地运行

bash
npm install
NS1_API_KEY=8H9sX... node index.js

Docker运行

bash
docker run -d -p 3000:3000 -e NS1_API_KEY=8H9sX... mondaycom/ns1-prometheus-exporter

Kubernetes部署

如需在Kubernetes中部署，包括用于指示Prometheus抓取指标端点的ServiceMonitor对象，请查看example/目录中的YAML配置文件。

环境变量配置

可通过以下环境变量配置导出器：

注意事项

导出器时间与Prometheus超时

调用/metrics端点时，导出器会从NS1 API获取近实时数据（如果最近1分钟内未获取过，即从缓存返回）。根据监控的区域/记录数量，端点响应可能需要几秒时间。在Kubernetes中使用ServiceMonitor时，可根据需要调整scrapeTimeout属性：

yaml
spec:
  endpoints:
    - interval: 30s
      path: /metrics
      scrapeTimeout: 15s
      ...

NS1 API速率限制说明

NS1对其API实施速率限制政策，详情参见NS1 API速率限制文档。

为确保获取所需监控数据的同时最小化API调用，建议配置：

• MONITOR_ZONES：如果有大量区域，可指定需监控的子集，减少不必要的API调用
• EXPORTER_GRANULARITY：对于包含数百/数千条DNS记录的大型区域，建议设为zone（区域级监控只需1次API调用，而记录级监控需为每条记录单独查询）

值准确性和每分钟查询的含义

NS1以QPS（每秒查询数）为单位公开DNS查询吞吐量，其定义如下：

...每分钟整点，使用5分钟前结束的两分钟内的查询计数计算新的QPS值。此查询计数除以120秒，得到该时间段的平均QPS

导出器通过将返回值乘以60得到每分钟查询数，并附带5分钟前（向下取整到该分钟开始）的时间戳。

由于上述差异，NS1网站显示的数据与导出器展示的数据可能存在微小差异，但这些值足够接近，可用于长期监控和活跃域名的指标分析。