Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add rtl_433 Prometheus exporter #96511

Merged
merged 5 commits into from Oct 23, 2020
Merged

Add rtl_433 Prometheus exporter #96511

merged 5 commits into from Oct 23, 2020

Conversation

zopieux
Copy link
Contributor

@zopieux zopieux commented Aug 28, 2020 •
edited

Motivation for this change

NixOS already packages rtl_433, an SDR receiver that among other things can decode metrics broadcast by 433MHz appliances such as thermometers.

This PR adds a lightweight Prometheus exporter written in Go for rtl_433 metrics.

I had to add further pkgs/modules (see first commits) to make that work seamlessly:

  1. upstream rtl-sdr (0.6.0) is using a very permissive udev ruleset that makes devices o+rw, which is not okay, so I backport a commit from their master branch to make it more locked-down
  2. because of 1. I had to make sure the "plugdev" group exists, so I introduce a small hardware.rtl-sdr module that enables said udev rules and ensures the group exists
  3. finally, I add the rtl_433_prometheus package and exporter module
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

delroth
delroth requested changes Aug 28, 2020
View reviewed changes
Copy link
Contributor

@delroth delroth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check https://nixos.org/nixpkgs/manual/#submitting-changes-making-patches re: commit message formatting.

In general it's also preferred to split off package and NixOS module into two separate commits.

pkgs/servers/monitoring/prometheus/rtl_433-exporter.nix Outdated Show resolved Hide resolved
pkgs/servers/monitoring/prometheus/rtl_433-exporter.nix Show resolved Hide resolved
nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix Outdated Show resolved Hide resolved
nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix Show resolved Hide resolved
nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix Outdated Show resolved Hide resolved
@ofborg ofborg bot requested a review from kalbasit August 28, 2020 00:59
@zopieux zopieux force-pushed the rtl_433_prom branch 3 times, most recently from 8cf12e4 to 97005a0 Compare August 28, 2020 01:34
@zopieux
Copy link
Contributor Author

zopieux commented Aug 28, 2020

Thanks for the quick review. PTAL, refactored how I build the matcher options in the module.

@zopieux zopieux requested a review from delroth August 28, 2020 01:47
delroth
delroth approved these changes Aug 28, 2020
View reviewed changes
Copy link
Contributor

@delroth delroth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one small issue left.

nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix Outdated Show resolved Hide resolved
@zopieux zopieux force-pushed the rtl_433_prom branch 4 times, most recently from d4a6f42 to 25f1f44 Compare August 28, 2020 23:53
@ofborg ofborg bot requested a review from bjornfor August 28, 2020 23:58
@zopieux zopieux force-pushed the rtl_433_prom branch 2 times, most recently from 72d9ce8 to 60ea72d Compare August 29, 2020 00:19
@zopieux zopieux force-pushed the rtl_433_prom branch 3 times, most recently from a214c9f to c404562 Compare August 29, 2020 01:58
@zopieux zopieux marked this pull request as ready for review August 29, 2020 01:59
@zopieux zopieux force-pushed the rtl_433_prom branch 2 times, most recently from 92f527f to b73d88d Compare August 29, 2020 20:55
@delroth
Copy link
Contributor

delroth commented Sep 19, 2020

FYI I'm now using this successfully on one of my systems. delroth/infra.delroth.net@067c709

@WilliButz any way you could help move this PR forward? I've done some review passes already and I feel like it's in a good shape, modulo one comment on "how to enable the hardware.* support when the exporter is enabled" still pending.

@zopieux
rtl-sdr: use hardened udev rules
f816402 
rtl-sdr latest release 0.6.0 is from 2018. Six months ago master received
a patch[1] to use improved udev rules that chown to plugdev instead of
making the devices world-read-writable.

This change backports [1] as an upstream patch.

[1] https://osmocom.org/projects/rtl-sdr/repository/revisions/b2814731563be4d5a0a68554ece6454a2c63af12
@zopieux
nixos/hardware/rtl-sdr: new module
b9750a9 
This is a very thin module to ensure "plugdev" user exists and some udev
rules are enabled, a prerequisite for using rtl-sdr.
@zopieux
maintainers: add zopieux
86fb21c
@zopieux
Copy link
Contributor Author

zopieux commented Sep 30, 2020

Upstream tagged a release, updated to use it instead of commit hash.

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review/3032/317

WilliButz
WilliButz requested changes Oct 22, 2020
View reviewed changes
Copy link
Member

@WilliButz WilliButz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please excuse my delayed review, I made a few small improvement suggestions, otherwise this looks good to me.

Thanks for the contribution 👍

pkgs/servers/monitoring/prometheus/rtl_433-exporter.nix Outdated Show resolved Hide resolved
pkgs/servers/monitoring/prometheus/rtl_433-exporter.nix Outdated Show resolved Hide resolved
pkgs/servers/monitoring/prometheus/rtl_433-exporter.nix Show resolved Hide resolved
nixos/modules/services/monitoring/prometheus/exporters.nix Show resolved Hide resolved
pkgs/servers/monitoring/prometheus/rtl_433-exporter.nix Outdated Show resolved Hide resolved
WilliButz
WilliButz approved these changes Oct 23, 2020
View reviewed changes
Copy link
Member

@WilliButz WilliButz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@WilliButz WilliButz merged commit 993437d into NixOS:master Oct 23, 2020
@zopieux zopieux deleted the rtl_433_prom branch October 23, 2020 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@delroth delroth delroth approved these changes

@WilliButz WilliButz WilliButz approved these changes

@kalbasit kalbasit Awaiting requested review from kalbasit

@bjornfor bjornfor Awaiting requested review from bjornfor

Assignees
No one assigned
Labels
6.topic: nixos 8.has: module (update) 8.has: package (new) 10.rebuild-darwin: 11-100 10.rebuild-linux: 11-100 11.by: package-maintainer
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@zopieux @delroth @nixos-discourse @WilliButz