Go to file
Robert Jacob 9573c83179 Update build system 2020-06-21 14:57:31 +02:00
_ci Update Go version used for build. 2018-09-02 00:19:13 +02:00
.dockerignore Update build system 2020-06-21 14:57:31 +02:00
.gitignore Add readme and license. 2017-01-08 23:45:31 +01:00
CHANGELOG.md Release 1.2.0 2018-10-27 17:21:07 +02:00
Dockerfile Update build system 2020-06-21 14:57:31 +02:00
LICENSE Update license. 2018-02-18 02:26:04 +01:00
Makefile Update build system 2020-06-21 14:57:31 +02:00
README.md Convert to Go module. 2018-10-27 17:02:55 +02:00
build-arm.sh Add build script. 2017-01-08 18:52:12 +01:00
collector.go Export Battery status, Wifi and RF signal strength (#4) 2018-10-06 15:24:55 +02:00
config.go Environment variables take precedence over flags. 2018-10-27 16:29:11 +02:00
config_test.go Environment variables take precedence over flags. 2018-10-27 16:29:11 +02:00
go.mod Update dependencies 2020-06-21 14:56:25 +02:00
go.sum Update dependencies 2020-06-21 14:56:25 +02:00
main.go Use updated Prometheus handler. 2018-10-27 17:07:08 +02:00

README.md

netatmo-exporter Docker Build Status

Simple prometheus exporter for getting sensor values NetAtmo sensors into prometheus.

Installation

Run docker container

The exporter is available as a Docker image: xperimental/netatmo-exporter

The latest tag is built from the current master, tags tagged since the Docker support was added are also available as a tag in Docker.

Build from source

Because this program uses the "Go Module" feature introduced in Go 1.11, you'll need at least that version of Go for building it.

If you have a working Go installation, getting the binary should be as simple as

git clone https://github.com/xperimental/netatmo-exporter
cd netatmo-exporter
go build .

There is also a build-arm.sh script if you want to run the exporter on an ARMv7 device.

NetAtmo client credentials

This application tries to get data from the NetAtmo API. For that to work you will need to create an application in the NetAtmo developer console, so that you can get a Client ID and secret.

Usage

$ netatmo-exporter --help
Usage of netatmo-exporter:
  -a, --addr string            Address to listen on. (default ":9210")
  -i, --client-id string       Client ID for NetAtmo app.
  -s, --client-secret string   Client secret for NetAtmo app.
  -p, --password string        Password of NetAtmo account.
  -u, --username string        Username of NetAtmo account.

After starting the server will offer the metrics on the /metrics endpoint, which can be used as a target for prometheus.

Passing secrets

You can pass credentials either via command line arguments (see next section) or by populating the following environment variables:

  • NETATMO_EXPORTER_ADDR Address to listen on
  • NETATMO_CLIENT_ID Client ID for NetAtmo app
  • NETATMO_CLIENT_SECRET Client secret for NetAtmo app
  • NETATMO_CLIENT_USERNAME Username of NetAtmo account
  • NETATMO_CLIENT_PASSWORD Password of NetAtmo account

Scrape interval

The exporter will query the Netatmo API every time it is scraped by prometheus. It does not make sense to scrape the Netatmo API with a small interval as the sensors only update their data every few minutes, so don't forget to set a slower scrape interval for this exporter:

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