From bba807b7c6031b30a5c8b24330b7bba51aebafe1 Mon Sep 17 00:00:00 2001
From: Jan Grewe <jan.grewe@flixbus.com>
Date: Thu, 7 Jun 2018 15:52:34 +0200
Subject: [PATCH] Readme: use table for metrics

---
 README.md | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 27412b0..390613e 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
 # Nexenta Exporter for Prometheus
 This Prometheus exporter uses the Nexenta API to provide metrics for JBODs, volumes and license informations.
 
-Currently implemented metrics:
-* `nexenta_up`
-* `nexenta_scrape_failures_total`
-* `nexenta_jbod_status`
-* `nexenta_jbod_temp`
-* `nexenta_jbod_voltage` 
-* `nexenta_jbod_slot_status`
-* `nexenta_volume_online`
-* `nexenta_license_days_left`
+#### Currently implemented metrics:
+Metric | Type | Description
+--- | --- | ---
+`nexenta_up` | gauge | Is the Nexenta API reachable (0/1)
+`nexenta_scrape_failures_total` | counter |Number of errors while scraping the Nexenta API
+`nexenta_jbod_status` | gauge | Status of JBOD (0/1)
+`nexenta_jbod_temp` | gauge | Temperature of JBOD (°C)
+`nexenta_jbod_voltage` | gauge | Voltage of JBOD (Volts)
+`nexenta_jbod_slot_status` | gauge | Status of JBOD slot (0/1)
+`nexenta_volume_online` | gauge | Is the volume online (0/1)
+`nexenta_license_days_left` | gauge | License days left
-- 
GitLab