search

NICMx / Jool

SIIT and NAT64 for Linux
GNU General Public License v2.0
320 stars 66 forks source link

Add information about `jool-exporter` to jool Ducoumentation #348

Closed cooperlees closed 3 years ago

cooperlees commented 3 years ago

Hi,

I wanted to see over time the trends / usage patterns for my home network's jool usage. To do this I've written a simple prometheus exporter that wraps the jool stats display --csv --explain command that allows Prometheus to come and scrape the data storing the key value pairs into it's time series database.

My Example home Dashboard:

grafana_jool_example

I've open sourced this to GitHub + pushed to PyPI.

Would you be open to me adding this into your documentation somewhere? If so, where? Happy to do the PR.

Once again, thanks for jool!

ydahhrk commented 3 years ago

Hey! Thank you for this.

Since your project is a publicly available more useful version of stats, it should definitely be prominently linked there.

If you want to write a dedicated documentation page, it should be linked in the index. Its location would depend on whether it's a tutorial or not. What exactly do you have in mind?

Please disclaim (or somehow reasonably imply, don't need an elaborate paragraph, especially if you're not writing a dedicated page) that we do not maintain your software, similar to the distribution package adverts:

Please note that these binaries are not maintained nor supervised by the Jool team. We are still available for advice if issues arise, however.

I noticed that the CAP_NET_ADMIN gimmic gave you some trouble. Looking at nstat, it seems Jool is being overly paranoid in demanding privileges to provide statistics. Would you agree?

cooperlees commented 3 years ago

Awesome. Agree on all. Was just going to make a small mention and state refer to the README.md on the project for more information.

I do also agree that reading from netlink etc. shouldn't need this admin. So if I get some spare time I'd be interested in taking a look to remove that need, if someone more knowledgable does not beat me :) - Should we open a dedicated issue for that?