Files
aaisp-chaos/cmd/aaisp_exporter/README.md
James O'Gorman 85eccc7bef Note exporter environment variables and listen flag
The README for the Prometheus exporter failed to mention that you must
set some environment variables for authentication or that you can change
the address the exporter listens on.
2019-10-13 17:48:26 +01:00

15 lines
786 B
Markdown

# AAISP Exporter
A Prometheus exporter for information about [Andrews and Arnold](https://aa.net.uk) broadband lines.
It exposes metrics:
* **aaisp_broadband_quota_remaining**: The line's remaining in the current monthly quota in bytes
* **aaisp_broadband_quota_total**: The line's monthly quota in bytes, excluding rollover
* **aaisp_broadband_rx_rate**: The line's receive (upload) rate in bits per second
* **aaisp_broadband_tx_rate**: The line's transmit (download) rate in bits per second
To run the service you must export environment variables `CHAOS_CONTROL_LOGIN` and `CHAOS_CONTROL_PASSWORD` using the login details you use for https://control.aa.net.uk/.
The service takess a `-listen` flag for setting the address and port the service binds to. The default is `:8080`.