Improves readme

- add toc - updates build instructions - fixed some typos
4 years ago · 8fe58d46bb
1 changed files with 68 additions and 42 deletions
--- a/README.md
+++ b/README.md
@ -1,8 +1,7 @@
 # Fritz!Box Upnp statistics exporter for prometheus

-This exporter exports some variables from an 
-[AVM Fritzbox](http://avm.de/produkte/fritzbox/)
-to prometheus.
+This exporter exports some variables from an
+[AVM Fritzbox](http://avm.de/produkte/fritzbox/) to prometheus.

 This exporter is tested with a Fritzbox 7590 software version 07.12, 07.20, 07.21 and 07.25.

@ -24,58 +23,82 @@ Other changes:
  - support for metrics from lua APIs (e.g. CPU temperature, utilization, ...)
 

+[TOC]: # "## Table of Contents"
+
+## Table of Contents
+- [Building](#building)
+- [Running](#running)
+- [Exported metrics](#exported-metrics)
+- [Output of `-test`](#output-of--test)
+- [Customizing metrics](#customizing-metrics)
+- [Grafana Dashboard](#grafana-dashboard)
+
 ## Building

-    go get github.com/sberk42/fritzbox_exporter/
-    cd $GOPATH/src/github.com/sberk42/fritzbox_exporter
-    go install
+```shell script
+git clone https://github.com/chr-fritz/fritzbox_exporter.git
+cd fritzbox_exporter
+go mod download
+go build
+```

 ## Running

-In the configuration of the Fritzbox the option "Statusinformationen über UPnP übertragen" in the dialog "Heimnetz >
-Heimnetzübersicht > Netzwerkeinstellungen" has to be enabled.
+In the configuration of the Fritzbox the option `Statusinformationen
+über UPnP übertragen` in the dialog `Heimnetz > Heimnetzübersicht >
+Netzwerkeinstellungen` has to be enabled.

 Usage:

-    $GOPATH/bin/fritzbox_exporter -h
-    Usage of ./fritzbox_exporter:
-      -gateway-url string
-        The URL of the FRITZ!Box (default "http://fritz.box:49000")
-      -gateway-luaurl string
-        The URL of the FRITZ!Box UI (default "http://fritz.box")
-      -metrics-file string
-        The JSON file with the metric definitions. (default "metrics.json")
-      -lua-metrics-file string
-        The JSON file with the lua metric definitions. (default "metrics-lua.json")
-      -test
-        print all available SOAP calls and their results (if call possible) to stdout
-      -json-out string
-        store metrics also to JSON file when running test   
-      -testLua
-        read luaTest.json file make all contained calls and dump results
-      -collect
-        collect metrics once print to stdout and exit
-      -nolua
-        disable collecting lua metrics
-      -username string
-        The user for the FRITZ!Box UPnP service
-      -password string
-        The password for the FRITZ!Box UPnP service
-      -listen-address string
-        The address to listen on for HTTP requests. (default "127.0.0.1:9042")
+```
+$GOPATH/bin/fritzbox_exporter -h
+Usage of ./fritzbox_exporter:
+  -gateway-url string
+    The URL of the FRITZ!Box (default "http://fritz.box:49000")
+  -gateway-luaurl string
+    The URL of the FRITZ!Box UI (default "http://fritz.box")
+  -metrics-file string
+    The JSON file with the metric definitions. (default "metrics.json")
+  -lua-metrics-file string
+    The JSON file with the lua metric definitions. (default "metrics-lua.json")
+  -test
+    print all available SOAP calls and their results (if call possible) to stdout
+  -json-out string
+    store metrics also to JSON file when running test   
+  -testLua
+    read luaTest.json file make all contained calls and dump results
+  -collect
+    collect metrics once print to stdout and exit
+  -nolua
+    disable collecting lua metrics
+  -username string
+    The user for the FRITZ!Box UPnP service
+  -password string
+    The password for the FRITZ!Box UPnP service
+  -listen-address string
+    The address to listen on for HTTP requests. (default "127.0.0.1:9042")
+```
    
-    The password (needed for metrics from TR-064 API) can be passed over environment variables to test in shell:
-    read -rs PASSWORD && export PASSWORD && ./fritzbox_exporter -username <user> -test; unset PASSWORD
+The password (needed for metrics from TR-064 API) can be passed over environment variables to test in shell:
+```shell script
+read -rs PASSWORD && export PASSWORD && ./fritzbox_exporter -username <user> -test; unset PASSWORD
+```

 ## Exported metrics

-start exporter and run
+Start the exporter and run:
+
+```shell script
 curl -s http://127.0.0.1:9042/metrics 
+```

-## Output of -test
+## Output of `-test`

-The exporter prints all available Variables to stdout when called with the -test option.
-These values are determined by parsing all services from http://fritz.box:49000/igddesc.xml and http://fritzbox:49000/tr64desc.xml (for TR64 username and password is needed!!!)
+The exporter prints all available Variables to `stdout` when called with
+the `-test` option. It retrieves these values by parsing all services
+from <http://fritz.box:49000/igddesc.xml> and
+<http://fritzbox:49000/tr64desc.xml>. To access TR64 the exporter needs
+username and password.

 ## Customizing metrics

@ -83,10 +106,13 @@ The metrics to collect are no longer hard coded, but have been moved to the [met
 For a list of all the available metrics just execute the exporter with -test (username and password are needed for the TR-064 API!)
 For lua metrics open UI in browser and check the json files used for the various screens.

-For a list of all available metrics, see the dumps below (the format is the same as in the metrics.json file, so it can be used to easily add further metrics to retrieve):
+For a list of all available metrics, see the dumps below (the format is
+the same as in the metrics.json file, so it can be used to easily add
+further metrics to retrieve):
 - [FritzBox 7590 v7.12](all_available_metrics_7590_7.12.json)
 - [FritzBox 7590 v7.20](all_available_metrics_7590_7.20.json)
 - [FritzBox 7590 v7.25](all_available_metrics_7590_7.25.json)
 ## Grafana Dashboard

-The dashboard is now also published on [Grafana](https://grafana.com/grafana/dashboards/12579).
+The dashboard is now also published on
+[Grafana](https://grafana.com/grafana/dashboards/12579).