From 247f81e5b41fea9b1de2151e7318392c03e44c0b Mon Sep 17 00:00:00 2001 From: Jos Collin Date: Wed, 30 Nov 2022 14:50:28 +0530 Subject: [PATCH] doc: updates --dump and --dumpfs Fixes: https://tracker.ceph.com/issues/57014 Signed-off-by: Jos Collin --- doc/cephfs/cephfs-top.rst | 8 ++++++++ doc/man/8/cephfs-top.rst | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/doc/cephfs/cephfs-top.rst b/doc/cephfs/cephfs-top.rst index 5192b9a5e1714..4c1fdc669bb14 100644 --- a/doc/cephfs/cephfs-top.rst +++ b/doc/cephfs/cephfs-top.rst @@ -80,6 +80,14 @@ By default, `cephfs-top` connects to cluster name `ceph`. To use a non-default c Interval should be greater than or equal to 0.5 seconds. Fractional seconds are honoured. +To dump the metrics to stdout without creating a curses display use:: + + $ cephfs-top --dump + +To dump the metrics of the given filesystem to stdout without creating a curses display use:: + + $ cephfs-top --dumpfs + Interactive Commands -------------------- diff --git a/doc/man/8/cephfs-top.rst b/doc/man/8/cephfs-top.rst index e20579564d269..fd18ada77ae06 100644 --- a/doc/man/8/cephfs-top.rst +++ b/doc/man/8/cephfs-top.rst @@ -44,6 +44,14 @@ Options Refresh interval in seconds (default: 1) +.. option:: --dump + + Dump the metrics to stdout + +.. option:: --dumpfs + + Dump the metrics of the given filesystem to stdout + Descriptions of fields ====================== -- 2.39.5