iqair_exporter

command module
v0.0.0-...-307c527 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 26, 2021 License: MIT Imports: 17 Imported by: 0

README

iqair_exporter

This is a Prometheus exporter to collect air quality data from iqAir AirVisual air quality monitors.

It has been tested with the iqAir Air Visual Pro

Building

go mod tidy
go build .

Usage

Get the API URL for your device from the AirVisual portal.

  1. go to your dashboard
  2. click Devices
  3. click the vertical dots next to the device you want to monitor
  4. click the API tab
  5. copy the URL next to "Device API Link". It should be something like https://www.airvisual.com/api/v2/node/<hex string>

Now run the exporter:

./iqair_exporter --iqair.scrape-uri=$API_URL

Or with Docker:

TODO

By default, the exporter listens on port 9861 and exports metrics on /metrics

Scrape Config

TODO

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Documentation

Overview

Binary iqair_exporter implements a Prometheus collector for iqAir AirVisual air quality monitors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL