Apply some exporter standards

ContaAzul · Sep 5, 2018 · 88f9e34 · 88f9e34
1 parent a03ee02
commit 88f9e34
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ applications:
 ### Running
 
 ```console
-./newrelic_exporter --api-key=${NEWRELIC_API_KEY} --config=config.yml
+./newrelic_exporter --newrelic.api-key=${NEWRELIC_API_KEY} --config=config.yml
 ```
 
 Or with docker:
@@ -25,8 +25,9 @@ docker run -p 9112:9112 -v /path/to/my/config.yml:/config.yml -e "NEWRELIC_API_K
 
 ### Flags
 
-Name    | Description
---------|---------------------------------------------------------
-addr    | Address to bind the server (default `:9112`)
-api-key | Your New Relic API key (required)
-config  | Your configuration file path (default `config.yml`)
+Name               | Description
+-------------------|--------------------------------------------------------------------------
+web.listen-address | Address to listen on for web interface and telemetry (default `:9112`)
+web.telemetry-path | Path under which to expose metrics (default `/metrics`)
+newrelic.api-key   | Your New Relic API key (required)
+config             | Your configuration file path (default `config.yml`)
diff --git a/main.go b/main.go
@@ -15,10 +15,11 @@ import (
 const defaultBaseURL = "https://api.newrelic.com/"
 
 var (
-	version    = "dev"
-	addr       = kingpin.Flag("addr", "Address to bind the server").Default(":9112").OverrideDefaultFromEnvar("SERVER_ADDR").String()
-	apiKey     = kingpin.Flag("api-key", "New Relic API key").OverrideDefaultFromEnvar("NEWRELIC_API_KEY").String()
-	configFile = kingpin.Flag("config", "Configuration file path").Default("config.yml").OverrideDefaultFromEnvar("CONFIG_FILEPATH").String()
+	version       = "dev"
+	listenAddress = kingpin.Flag("web.listen-address", "Address to listen on for web interface and telemetry").Default(":9112").String()
+	metricsPath   = kingpin.Flag("web.telemetry-path", "Path under which to expose metrics.").Default("/metrics").String()
+	apiKey        = kingpin.Flag("newrelic.api-key", "New Relic API key").OverrideDefaultFromEnvar("NEWRELIC_API_KEY").String()
+	configFile    = kingpin.Flag("config", "Configuration file path").Default("config.yml").OverrideDefaultFromEnvar("CONFIG_FILEPATH").String()
 )
 
 func main() {
@@ -35,22 +36,22 @@ func main() {
 	var config = config.Parse(*configFile)
 	prometheus.MustRegister(collector.NewNewRelicCollector(defaultBaseURL, *apiKey, config))
 
-	http.Handle("/metrics", promhttp.Handler())
+	http.Handle(*metricsPath, promhttp.Handler())
 	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
 		fmt.Fprintf(w, // nolint: gas, errcheck
 			`
 			<html>
 			<head><title>NewRelic Exporter</title></head>
 			<body>
 				<h1>NewRelic Exporter</h1>
-				<p><a href="/metrics">Metrics</a></p>
+				<p><a href="`+*metricsPath+`">Metrics</a></p>
 			</body>
 			</html>
 			`)
 	})
 
-	log.Infof("Server listening on %s", *addr)
-	if err := http.ListenAndServe(*addr, nil); err != nil {
+	log.Infof("Server listening on %s", *listenAddress)
+	if err := http.ListenAndServe(*listenAddress, nil); err != nil {
 		log.Fatalf("Error starting server: %v", err)
 	}
 }