freifunk/fastd-exporter
0
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

update README.md

Browse source
This commit is contained in:
Martin Weinelt 2017-04-01 21:18:53 +02:00
parent 560638ee4e
commit 4c19c282e8
No known key found for this signature in database
GPG key ID: BD4AA0528F63F17E
1 changed files with 28 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -1,10 +1,9 @@
# fastd-exporter
We are building a prometheus exporter for the fastd vpn daemon. We don't have a working version yet, stay tuned
We are building a prometheus exporter for the fastd vpn daemon.
## Formatting
We are using `go fmt` for formatting the code.
We have a working version, but the metrics, and by extension their labels, are not stable yet.
When they are we will very likely be tagging our first release.
## Getting Started
@ -20,4 +19,28 @@ and
$ ./fastd-exporter --instance ffda
```
It will print json data received from the socket and maybe also show metrics on `http://127.0.0.1:9099/metrics`.
The exporter will need read access to both the instances `fastd.conf` and `status socket`, keep that in mind.
By default the metrics webserver will listen on `:9099`, which can be changed through the `--web.listen-address` parameter.
Check out the help for additional information.
```
$ ./fastd-exporter --help
```
## Development
We are happy to discuss the fastd-exporter with you on:
> irc.hackint.org
> #ffda-exporter
### Formatting
We are using go's internal formatting for this codebase.
```
$ go fmt
```