https://github.com/susji/ruuvimetrics

Minimalistic server for exposing RuuviTag sensor data as Prometheus-like metrics over HTTP
https://github.com/susji/ruuvimetrics

go golang prometheus prometheus-metrics ruuvi ruuvi-ble-devices ruuvitag ruuvitag-sensor

Last synced: 3 months ago
JSON representation

Minimalistic server for exposing RuuviTag sensor data as Prometheus-like metrics over HTTP

• Host: GitHub
• URL: https://github.com/susji/ruuvimetrics
• Owner: susji
• License: apache-2.0
• Created: 2024-04-07T20:58:36.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-11T05:32:23.000Z (over 1 year ago)
• Last Synced: 2025-02-07T19:13:49.390Z (8 months ago)
• Topics: go, golang, prometheus, prometheus-metrics, ruuvi, ruuvi-ble-devices, ruuvitag, ruuvitag-sensor
• Language: Go
• Homepage:
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ruuvimetrics

This program maintains Ruuvi sensor values and exposes them via HTTP for a

Prometheus-like consumer who accepts [the text-based exposition

format](https://github.com/prometheus/docs/blob/main/content/docs/instrumenting/exposition_formats.md#text-based-format).

The program composes nicely with [ruuviscan](https://github.com/susji/ruuviscan)

and [ruuviparse](https://github.com/susji/ruuviparse). You can feed input data

to ruuvimetrics directly from Bluetooth Low Energy (BLE) reception (ruuviscan)

or with raw BLE Advertisement packets (ruuviparse). The idea is that those

programs generate sensor values as JSON to standard output and this program

reads sensor values from standard input.

# Installing

Builds for many platforms can be found

[here](https://github.com/susji/ruuvimetrics/releases). You may also use the Go

toolchain:

    $ go install github.com/susji/ruuvimetrics/cmd/ruuvimetrics@latest

# Usage

`ruuvimetrics` has some command-line arguments. To see them, invoke

    $ ruuvimetrics -h

For local BLE scans, invoke

    $ ruuviscan | ruuvimetrics

and then wait for values to be aggregated and query them with some HTTP client:

    $ curl http://localhost:9900/metrics

For parsing and exposing Ruuvi sensor values via MQTT, you probably have to

figure out how your transmitters or BLE proxies send the values, but it might

look something like

[this](https://github.com/susji/ruuviparse#integrating-with-mqtt-messaging):

    $ mosquitto_sub \

        -h mqtt.example.com \

        -t ruuvi/001 \

        --cert ruuvi-listener.cert.pem \

        --key ruuvi-listener.private.key \

        --cafile ca.crt \

        -i ruuvi-listener \

        | jq --raw-output --unbuffered \

          '.ads[].ad | ascii_downcase | select(.[8:14] == "ff9904") | .[14:]' \

        | ruuviparse \

        | ruuvimetrics