From 862a1b49fad4b764cebc01f42642bae0908af411 Mon Sep 17 00:00:00 2001 From: Phil Porada Date: Fri, 28 Jul 2017 12:49:11 -0400 Subject: [PATCH] Updates per comments in PR --- README.md | 33 ++++++++++----------------------- 1 file changed, 10 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index c3ea92d..5e6d77a 100644 --- a/README.md +++ b/README.md @@ -7,31 +7,18 @@ command, causing Unbound to return metrics as key-value pairs. The metrics exporter converts Unbound metric names to Prometheus metric names and labels by using a set of regular expressions. -Please refer to this utility's `main()` function for a list of supported -command line flags. +- - - - + +# Installation + +To install this code and in your go environment. You can then add the binary to your `PATH`. + + go install github.com/kumina/unbound_exporter - - - - -# Building +# Usage -To build this code, you'll need a working `go` environment. Once you have a suitable environment, simply run the following commands +To show all CLI flags available - go get - go build unbound_exporter.go - -If your build is working successfully, you should see the following output. - - ./unbound_exporter -h - Usage of ./unbound_exporter: - -unbound.ca string - Unbound server certificate. (default "/etc/unbound/unbound_server.pem") - -unbound.cert string - Unbound client certificate. (default "/etc/unbound/unbound_control.pem") - -unbound.host string - Unbound control socket hostname and port number. (default "localhost:8953") - -unbound.key string - Unbound client key. (default "/etc/unbound/unbound_control.key") - -web.listen-address string - Address to listen on for web interface and telemetry. (default ":9167") - -web.telemetry-path string - Path under which to expose metrics. (default "/metrics") + unbound_exporter -h