https://github.com/madchicken/homebridge-prometheus-exporter
Simple prometheus exporter for home bridge
https://github.com/madchicken/homebridge-prometheus-exporter
homebridge prometheus-exporter
Last synced: 4 months ago
JSON representation
Simple prometheus exporter for home bridge
- Host: GitHub
- URL: https://github.com/madchicken/homebridge-prometheus-exporter
- Owner: madchicken
- Created: 2022-10-24T11:02:06.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T21:24:17.000Z (about 1 year ago)
- Last Synced: 2024-10-29T21:24:31.538Z (7 months ago)
- Topics: homebridge, prometheus-exporter
- Language: Rust
- Homepage:
- Size: 29.3 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Prometheus Exporter for Homebridge
A simple exporter for Prometheus that reads information about all your devices and exports all values as Prometheus metrics.
## Usage
`prometheus-exporter` is a command line program that takes few parameters:
```text
USAGE:
homebridge-exporter [OPTIONS] --username --password
OPTIONS:
--debug Debug mode (displays additional log lines)
-h, --help Print help information
--keyfile Authorization keys file. Default to authorization-keys.yml in the
current working directory [default: authorization-keys.yml]
-p, --password Homebridge password
--port Metrics webserver port (service /metrics for Prometheus scraper)
[default: 9123]
--prefix Registry metrics prefix [default: homebrige]
-u, --username Homebridge username
--uri Homebridge UI uri [default: http://localhost:8581]
-V, --version Print version information
```
This software scrapes all the accessories from homebridge APIs and creates prometheus metrics out of all services information.
All the metrics are then exposed under the standard path `/metrics` by the embedded HTTP server.
## /restart endpoint
The exporter also exposes an additional endpoint that you can use to restart your homebridge server in case you detect some problem with metric values (for example from Prometheus AlertManager).
The endpoint is mapped at `/restart` path and must be used sending a POST request, containing an Authorization header holding a bearer token you should generate and put inside the file `authorization-keys.yml` (or in your custom yaml file you specified in the `--keyfile` parameter) .
An example of the content of this file is this:
```yaml
keys:
- 1d3f962f-bdcf-4f08-85ce-3e109f4e8f62
```
You can then use this CURL to trigger your Homebridge instance to restart:
```shell
curl -X POST -H "Authorization: Bearer 1d3f962f-bdcf-4f08-85ce-3e109f4e8f62" http://YOUR_IP:9123/restart
```
**NOTE**: if the key file does not exist the `/restart` endpoint won't do anything.
## Build from source
This project is written in Rust and uses Cargo to compile and link the final executable.
To be able to build the final executable, you need first to install Rust, following the instructions [here](https://www.rust-lang.org/tools/install).
Once your environment is ready, you can build the project by running the command:
cargo build
To build in release more, just add `-r` to the above command.
If you want to build only a specific target, specify it using the `--target` parameter:
cargo build --target x86_64-apple-darwin
Supported targets are defined in the [cargo config file](blob/master/.cargo/config.toml).