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

Update pkg-descr #4338

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions sysutils/node_exporter/pkg-descr
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ written in Go with pluggable metric collectors.

WWW: https://github.com/prometheus/node_exporter

***Please note that this needs to be enabled via Services: Prometheus Exporter.
Copy link
Member

Choose a reason for hiding this comment

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

Looks like you want to add a plugin documentation instead? That would be a good place to add this kind of information about how to set it up.

Copy link
Author

Choose a reason for hiding this comment

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

Considering I spent the afternoon trying to figure out how to do this, and the main place I looked was the plugin file I would say that as a starter for 10 this would be a good 0lace to start. Beyond that some documentation would be good, but I think either the plugin or the service description needs changing to be consistent as it isn't immediately obvious that node-exporter relates to a service description of prometheus at all. Just my 2p tho.


The source for this plugin is located at https://github.com/opnsense/plugins/edit/master/sysutils/node_exporter

Changelog
---------
Expand Down