fastd-exporter/README.md

47 lines
865 B
Markdown
Raw Normal View History

2017-03-27 20:05:09 +02:00
# fastd-exporter
2017-04-01 21:18:53 +02:00
We are building a prometheus exporter for the fastd 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.
## Getting Started
2017-03-27 20:05:09 +02:00
For now run
```
$ go build
```
and
```
$ ./fastd-exporter --instance ffda
```
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.
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:
> irc.hackint.org
> #ffda-exporter
### Formatting
We are using go's internal formatting for this codebase.
```
$ go fmt
```