From 4c19c282e81e07dd7bdacaa35e8263a2f5042030 Mon Sep 17 00:00:00 2001 From: Martin Weinelt Date: Sat, 1 Apr 2017 21:18:53 +0200 Subject: [PATCH] update README.md --- README.md | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6f36ce1..d3cfd5c 100644 --- a/README.md +++ b/README.md @@ -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 +```