From 21c426833972baab588b5bf31c077660aa3e01ff Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch>
Date: Mon, 11 Dec 2023 11:06:46 +0100
Subject: [PATCH] ceph io fix help text

---
 docs/20_Checks/check_ceph_io.md | 35 ++++++++++++++-------------------
 1 file changed, 15 insertions(+), 20 deletions(-)

diff --git a/docs/20_Checks/check_ceph_io.md b/docs/20_Checks/check_ceph_io.md
index 30775df..31e4301 100644
--- a/docs/20_Checks/check_ceph_io.md
+++ b/docs/20_Checks/check_ceph_io.md
@@ -18,40 +18,35 @@ icingaclient ALL=(ALL) NOPASSWD: /bin/ceph
 ```txt
 ______________________________________________________________________
 
-CHECK_DISK-IO
-v1.1
+CHECK_CEPH_IO
+v1.5
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3
 
-https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_disk-io.html
+https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_ceph_io.html
 ______________________________________________________________________
 
-Disk infos based on /sys/block/[NAME]/stat
-See https://www.kernel.org/doc/Documentation/block/stat.txt
-and https://www.kernel.org/doc/Documentation/iostats.txt
-
-The system data are counters that are difficult to read.
-The output of this check for each value a delta value per second since 
-last check.
+Show cheph IO as read and written bytes per second.
+This check sends performance data.
 
 SYNTAX:
-check_disk-io -m MODE
+check_ceph_io
 
 OPTIONS:
-
-    -m MODE        set mode for type of output (required)
     -h or --help   show this help.
+    -t [STRING]    test a value; for debugging purposes
+                   Without a string internally stored values will be tested
 
-PARAMETERS:
+EXAMPLE:
+check_ceph_io
+    no parameters; normal usage to get the ceph io data
 
-    MODE
-        io         read I/Os, write I/Os, discard I/0s
-        ticks      read ticks, write ticks, discard ticks
-        wait       total wait time for all requests
+check_ceph_io -t
+    Run a few builtin tests
 
-EXAMPLE:
-check_disk-io -m io
+check_ceph_io -t "   client: 255 B/s rd, 0 op/s rd, 0 op/s wr"
+    Test a given string
 
 ```
 
-- 
GitLab