xperimental/netatmo-exporter

netatmo-exporter

简单的Prometheus导出器，用于将NetAtmo传感器的传感器值导入Prometheus。

安装

运行Docker容器

该导出器作为Docker镜像在DockerHub和GitHub上均有提供：

• https://github.com/xperimental/netatmo-exporter/pkgs/container/netatmo-exporter
• https://hub.docker.com/r/xperimental/netatmo-exporter/

可用标签如下：

• x.y.z：指向该版本的发布
• latest：指向最新发布的版本
• master：指向默认分支的最新构建

示例Docker运行命令：

bash
docker run -d -p 9210:9210 \
  -e NETATMO_CLIENT_ID=你的客户端ID \
  -e NETATMO_CLIENT_SECRET=你的客户端密钥 \
  -e NETATMO_EXPORTER_TOKEN_FILE=/data/token.json \
  -v ./data:/data \
  xperimental/netatmo-exporter:latest

从源码构建

由于该程序使用Go 1.11中引入的"Go Module"特性，因此构建至少需要该版本的Go。

如果已安装可用的Go环境，获取二进制文件的步骤如下：

bash
git clone https://github.com/xperimental/netatmo-exporter
cd netatmo-exporter
make

如需为其他操作系统或架构构建导出器，可向Makefile指定参数：

bash
# 针对Linux 64位ARM架构
GOOS=linux GOARCH=arm64 make build-binary

NetAtmo客户端凭据

此应用程序尝试从NetAtmo API获取数据。为此，需要在NetAtmo开发者控制台中创建应用，以获取Client ID和密钥。

认证方面，可使用导出器的集成Web界面，或使用开发者控制台创建令牌并手动提供给导出器使用。详见https://github.com/xperimental/netatmo-exporter/blob/master/doc/authentication.md%E3%80%82

导出器能够在重启期间持久化认证令牌，因此重启时无需用户交互，除非令牌在导出器未运行期间过期。有关用于持久化令牌的文件说明，详见https://github.com/xperimental/netatmo-exporter/blob/master/doc/token-file.md%E3%80%82

使用

plain
$ netatmo-exporter --help
Usage of netatmo-exporter:
  -a, --addr string                 监听地址。(默认 ":9210")
      --age-stale duration          视为过期的数据时长。过期数据不再生成指标。(默认 1h0m0s)
  -i, --client-id string            NetAtmo应用的Client ID。
  -s, --client-secret string        NetAtmo应用的Client Secret。
      --debug-handlers              启用调试HTTP处理器。
      --external-url string         用于OAuth重定向URL的基础外部URL。
      --log-level level             设置日志输出的最低级别。(默认 info)
      --refresh-interval duration   NetAtmo传感器数据内部缓存的时间间隔。(默认 8m0s)
      --token-file string           用于加载/持久化认证令牌的令牌文件路径。

服务器启动后，将在/metrics端点提供指标，可作为Prometheus的目标。

环境变量

导出器可通过命令行参数（见上节）或以下环境变量进行配置：

缓存数据

导出器对从Netatmo API检索的数据设有内存缓存。其目的是将Netatmo API请求与抓取间隔解耦，因为Netatmo的数据更新速度远低于Prometheus的默认抓取间隔。根据Netatmo文档，传感器数据每十分钟更新一次。导出器的默认"刷新间隔"设置为略低于此值（8分钟），但仍远高于Prometheus的默认抓取间隔（15秒）。

如有需要，可为此导出器设置较慢的抓取间隔：

yml
scrape_configs:
  - job_name: 'netatmo'
    scrape_interval: 90s
    static_configs:
      - targets: ['localhost:9210']

链接

• Grafana仪表板 由https://github.com/GordonFreemanK%E6%8F%90%E4%BE%9B