Go to file
Robert Jacob 1078a7301d Add changelog. 2018-09-02 18:00:04 +02:00
_ci Update Go version used for build. 2018-09-02 00:19:13 +02:00
vendor Vendor dependencies. 2018-02-18 00:57:33 +01:00
.gitignore Add readme and license. 2017-01-08 23:45:31 +01:00
CHANGELOG.md Add changelog. 2018-09-02 18:00:04 +02:00
Dockerfile Add Dockerfile. 2018-09-02 00:22:04 +02:00
Gopkg.lock Update to dep 0.5.0 2018-09-02 00:17:59 +02:00
Gopkg.toml Vendor dependencies. 2018-02-18 00:57:33 +01:00
LICENSE Update license. 2018-02-18 02:26:04 +01:00
README.md Update readme. 2018-09-02 00:29:01 +02:00
build-arm.sh Add build script. 2017-01-08 18:52:12 +01:00
collector.go Add station name as metric label (#3) 2018-09-02 17:54:15 +02:00
main.go Assign a default port. 2017-03-09 12:30:54 +01: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

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

go get github.com/xperimental/netatmo-exporter

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.

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']