netatmo2graphite 镜像文档

镜像概述

netatmo2graphite 镜像基于 GitHub 项目 sbrunner/netatmo2graphite 构建，是一款用于将 Netatmo 智能设备（如温湿度传感器、气象站等）的监测数据同步至 Graphite 监控系统的工具镜像。通过该镜像，用户可便捷地实现 Netatmo 设备数据与 Graphite 平台的集成，支持实时监控与历史数据趋势分析。

核心功能与特性

• 数据采集：通过 Netatmo API 自动获取设备监测数据（如温度、湿度、气压、空气质量等）。
• 格式转换：将 Netatmo 数据转换为 Graphite 兼容的格式（metric path + value + timestamp）。
• 定时同步：支持自定义同步间隔，实现周期性数据推送。
• 配置灵活：通过环境变量配置 Netatmo 凭证、Graphite 连接信息及同步参数。
• 轻量可靠：基于 Python 构建，镜像体积小，运行稳定。

使用场景与适用范围

• 家庭/办公环境监控：将 Netatmo 设备采集的环境数据（如室内温湿度、CO2 浓度）同步至 Graphite，实现可视化监控。
• 监控平台集成：将 Netatmo 数据整合到已有的 Graphite 监控体系，统一管理多源监控数据。
• 历史数据分析：借助 Graphite 的数据存储能力，长期留存 Netatmo 数据，用于趋势分析与异常检测。

使用方法与配置说明

前置条件

• 拥有 Netatmo 设备及开发者账号（需创建 Netatmo 应用以获取 API 凭证）。
• 已部署 Graphite 服务（支持 Carbon 接收端或 Graphite-API）。

环境变量配置

Docker 部署示例

1. 使用 docker run 命令

docker run -d \
  --name netatmo2graphite \
  -e NETATMO_CLIENT_ID="your-netatmo-client-id" \
  -e NETATMO_CLIENT_SECRET="your-netatmo-client-secret" \
  -e NETATMO_USERNAME="your-netatmo-username" \
  -e NETATMO_PASSWORD="your-netatmo-password" \
  -e GRAPHITE_HOST="graphite.example.com" \
  -e GRAPHITE_PORT=2003 \
  -e SYNC_INTERVAL=300 \
  -e METRIC_PREFIX="netatmo.livingroom" \
  sbrunner/netatmo2graphite

2. 使用 docker-compose 配置

创建 docker-compose.yml 文件：

version: '3'
services:
  netatmo2graphite:
    image: sbrunner/netatmo2graphite
    container_name: netatmo2graphite
    environment:
      - NETATMO_CLIENT_ID=your-netatmo-client-id
      - NETATMO_CLIENT_SECRET=your-netatmo-client-secret
      - NETATMO_USERNAME=your-netatmo-username
      - NETATMO_PASSWORD=your-netatmo-password
      - GRAPHITE_HOST=graphite.example.com
      - GRAPHITE_PORT=2003
      - SYNC_INTERVAL=300
      - METRIC_PREFIX=netatmo.office
    restart: unless-stopped

启动服务：

docker-compose up -d

验证与日志

查看容器运行日志以确认数据同步状态：

docker logs -f netatmo2graphite

若配置正确，日志将显示类似 Pushed X metrics to Graphite 的成功信息。

注意事项

• Netatmo API 存在调用频率限制，建议将 SYNC_INTERVAL 设置为 ≥300 秒（5分钟）。
• 确保 Graphite 服务允许容器所在网络的访问（防火墙需开放 GRAPHITE_PORT 端口）。
• Netatmo 账号密码建议使用环境变量注入，避免明文存储。