Compare commits

...

3 Commits

Author SHA1 Message Date
faba770930 fix requirements 2025-03-04 01:05:59 +01:00
e2f6b9a600 update schema 2025-03-04 01:05:43 +01:00
115d43cc79 Give some more info in readme 2025-03-03 22:41:59 +00:00
3 changed files with 23 additions and 11 deletions

View File

@ -1,11 +1,23 @@
# Prometheus Exporter
Export BFFH Data as Prometheus Metric
Export BFFH Data as Prometheus Metric.
# Env Variables
* POLLING_INTERVAL_SECONDS = 5
* EXPORTER_PORT = 9000
* BFFH_HOST = localhost
* BFFH_PORT = 59661
* BFFH_USER = Admin1
* BFFH_PASSWORD = secret
The exporter uses the [pyfabapi](https://docs.fab-access.org/books/schnittstellen-und-apis/page/fabaccess-api#bkmrk-pyfabapi) (Python API wrapper for FabAccess API) to access the resource list (machines) and their states and meta information (names, categories).
Sample line:
```
bffh_machine_state{category="Central Stairs",machine_id="zam-raum1-ecke1-lamp",machine_name="1 Lampe"} 1.0
```
# Installation & Documentation
Please see [docs.fab-access.org](https://docs.fab-access.org/books/schnittstellen-und-apis/page/monitoring-prometheus-loki-und-grafana#bkmrk-installation-von-fab) for installation steps and how to use together with Grafana.
## Installation with Docker
In case you want to use the provided Dockerfile, you can use the following environment variables to run:
* `POLLING_INTERVAL_SECONDS` = 5
* `EXPORTER_PORT` = 9000
* `BFFH_HOST` = localhost
* `BFFH_PORT` = 59661
* `BFFH_USER` = Admin1
* `BFFH_PASSWORD` = secret

@ -1 +1 @@
Subproject commit 286aca04723a6bca0dbdb4cc6928650f8764bb34
Subproject commit 7a4473f39a989b926eea0185fa665021baed6988

View File

@ -1,6 +1,6 @@
asyncio-mqtt
pycapnp
pycapnp==1.3.0
prometheus_client
requests
prometheus-async
aiohttp
aiohttp