From 4adf7fa96cee17741fdda415f29d19b3f4690f35 Mon Sep 17 00:00:00 2001
From: Ed Schouten <ed@kumina.nl>
Date: Fri, 23 Dec 2016 15:55:49 +0100
Subject: [PATCH] Improve the help strings, as proposed in the code review.

---
 collector/drbd_linux.go           | 10 +++++-----
 collector/fixtures/e2e-output.txt | 10 +++++-----
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/collector/drbd_linux.go b/collector/drbd_linux.go
index d51bcec9..3c2e948e 100644
--- a/collector/drbd_linux.go
+++ b/collector/drbd_linux.go
@@ -69,12 +69,12 @@ var (
 	drbdNumericalMetrics = map[string]drbdNumericalMetric{
 		"ns": newDRBDNumericalMetric(
 			"network_sent_bytes_total",
-			"Volume of net data sent to the partner via the network connection; in bytes.",
+			"Total number of bytes sent via the network.",
 			prometheus.CounterValue,
 			1024),
 		"nr": newDRBDNumericalMetric(
 			"network_received_bytes_total",
-			"Volume of net data received by the partner via the network connection; in bytes.",
+			"Total number of bytes received via the network.",
 			prometheus.CounterValue,
 			1),
 		"dw": newDRBDNumericalMetric(
@@ -104,12 +104,12 @@ var (
 			1),
 		"pe": newDRBDNumericalMetric(
 			"remote_pending",
-			"Number of requests sent to the partner, but that have not yet been answered by the latter.",
+			"Number of requests sent to the peer, but that have not yet been answered by the latter.",
 			prometheus.GaugeValue,
 			1),
 		"ua": newDRBDNumericalMetric(
 			"remote_unacknowledged",
-			"Number of requests received by the partner via the network connection, but that have not yet been answered.",
+			"Number of requests received by the peer via the network connection, but that have not yet been answered.",
 			prometheus.GaugeValue,
 			1),
 		"ap": newDRBDNumericalMetric(
@@ -141,7 +141,7 @@ var (
 
 	drbdConnected = prometheus.NewDesc(
 		prometheus.BuildFQName(Namespace, "drbd", "connected"),
-		"Whether DRBD is connected to the partner.",
+		"Whether DRBD is connected to the peer.",
 		[]string{"device"}, nil)
 )
 
diff --git a/collector/fixtures/e2e-output.txt b/collector/fixtures/e2e-output.txt
index 7ba713b3..dfd24de9 100644
--- a/collector/fixtures/e2e-output.txt
+++ b/collector/fixtures/e2e-output.txt
@@ -384,7 +384,7 @@ node_drbd_application_pending{device="drbd1"} 12348
 # HELP node_drbd_bitmap_writes_total Number of updates of the bitmap area of the meta data.
 # TYPE node_drbd_bitmap_writes_total counter
 node_drbd_bitmap_writes_total{device="drbd1"} 221
-# HELP node_drbd_connected Whether DRBD is connected to the partner.
+# HELP node_drbd_connected Whether DRBD is connected to the peer.
 # TYPE node_drbd_connected gauge
 node_drbd_connected{device="drbd1"} 1
 # HELP node_drbd_disk_read_bytes_total Net data read from local hard disk; in bytes.
@@ -403,10 +403,10 @@ node_drbd_epochs{device="drbd1"} 1
 # HELP node_drbd_local_pending Number of open requests to the local I/O sub-system.
 # TYPE node_drbd_local_pending gauge
 node_drbd_local_pending{device="drbd1"} 12345
-# HELP node_drbd_network_received_bytes_total Volume of net data received by the partner via the network connection; in bytes.
+# HELP node_drbd_network_received_bytes_total Total number of bytes received via the network.
 # TYPE node_drbd_network_received_bytes_total counter
 node_drbd_network_received_bytes_total{device="drbd1"} 1.0961011e+07
-# HELP node_drbd_network_sent_bytes_total Volume of net data sent to the partner via the network connection; in bytes.
+# HELP node_drbd_network_sent_bytes_total Total number of bytes sent via the network.
 # TYPE node_drbd_network_sent_bytes_total counter
 node_drbd_network_sent_bytes_total{device="drbd1"} 1.7740228608e+10
 # HELP node_drbd_node_role_is_primary Whether the role of the node is in the primary state.
@@ -416,10 +416,10 @@ node_drbd_node_role_is_primary{device="drbd1",node="remote"} 1
 # HELP node_drbd_out_of_sync_bytes Amount of data known to be out of sync; in bytes.
 # TYPE node_drbd_out_of_sync_bytes gauge
 node_drbd_out_of_sync_bytes{device="drbd1"} 1.2645376e+07
-# HELP node_drbd_remote_pending Number of requests sent to the partner, but that have not yet been answered by the latter.
+# HELP node_drbd_remote_pending Number of requests sent to the peer, but that have not yet been answered by the latter.
 # TYPE node_drbd_remote_pending gauge
 node_drbd_remote_pending{device="drbd1"} 12346
-# HELP node_drbd_remote_unacknowledged Number of requests received by the partner via the network connection, but that have not yet been answered.
+# HELP node_drbd_remote_unacknowledged Number of requests received by the peer via the network connection, but that have not yet been answered.
 # TYPE node_drbd_remote_unacknowledged gauge
 node_drbd_remote_unacknowledged{device="drbd1"} 12347
 # HELP node_entropy_available_bits Bits of available entropy.