2017-03-27 20:05:09 +02:00
|
|
|
# fastd-exporter
|
|
|
|
|
|
2018-05-23 15:11:04 +02:00
|
|
|
We are building a prometheus exporter for the [fastd](https://projects.universe-factory.net/projects/fastd/wiki) vpn daemon.
|
2017-03-27 20:05:09 +02:00
|
|
|
|
2017-04-01 21:18:53 +02:00
|
|
|
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.
|
2017-03-28 22:20:04 +02:00
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
2017-03-27 20:05:09 +02:00
|
|
|
For now run
|
|
|
|
|
|
|
|
|
|
```
|
2017-07-17 03:38:55 +02:00
|
|
|
$ go get github.com/freifunk-darmstadt/fastd-exporter
|
2017-03-27 20:05:09 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
and
|
|
|
|
|
|
|
|
|
|
```
|
2018-05-23 15:11:04 +02:00
|
|
|
$ ./fastd-exporter --instance ffda --metrics.perpeer
|
2017-03-27 20:05:09 +02:00
|
|
|
```
|
|
|
|
|
|
2017-04-01 21:18:53 +02:00
|
|
|
The exporter will need read access to both the instances `fastd.conf` and `status socket`, keep that in mind.
|
|
|
|
|
|
2017-07-17 03:24:21 +02:00
|
|
|
By default the metrics webserver will listen on `:9281`, which can be changed through the `--web.listen-address` parameter.
|
2017-04-01 21:18:53 +02:00
|
|
|
|
|
|
|
|
Check out the help for additional information.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ ./fastd-exporter --help
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
We are happy to discuss the fastd-exporter with you on:
|
|
|
|
|
|
2017-07-17 03:24:43 +02:00
|
|
|
> irc.hackint.org #fastd-exporter
|
2017-04-01 21:18:53 +02:00
|
|
|
|
|
|
|
|
### Formatting
|
|
|
|
|
|
|
|
|
|
We are using go's internal formatting for this codebase.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ go fmt
|
|
|
|
|
```
|
