docs: add sample metrics > METRICS.md

stefanwalther · Jun 23, 2017 · 0432043 · 0432043
1 parent 7dd2809
commit 0432043
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,5 @@
 FROM node:7.9.0
+MAINTAINER "Stefan Walther"
 
 ARG PORT=9696
 

diff --git a/METRICS.md b/METRICS.md
@@ -0,0 +1,13 @@
+# Metrics
+
+Below are an example of the metrics as exposed by this exporter. 
+
+```
+# TYPE speedtest_bits_per_second gauge
+# HELP speedtest_bits_per_second Speed measured against speedtest.net
+speedtest_bits_per_second{direction="downstream"} 117.949
+speedtest_bits_per_second{direction="upstream"} 26.472
+# TYPE speedtest_ping gauge
+# HELP speedtest_ping Ping in ms
+speedtest_ping 22.6
+```