From 97fc11219cb39baadcf3d7829496502560a26247 Mon Sep 17 00:00:00 2001 From: zbyrne Date: Fri, 13 Mar 2026 12:59:02 -0400 Subject: [PATCH] Add initial doc for stats collection describing ais-stats usage. --- docs/stats_collection.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/stats_collection.rst diff --git a/docs/stats_collection.rst b/docs/stats_collection.rst new file mode 100644 index 00000000..e9d5e597 --- /dev/null +++ b/docs/stats_collection.rst @@ -0,0 +1,27 @@ +Stats Collection Tool +===================== + +Command-line Tool +----------------- +``ais-stats`` can be run two ways: +* ``$ ais-stats -p [-i]`` will collect stats from a running process. + ``-i`` will report immediately rather than wait for the process to exit. +* ``$ ais-stats [args...]`` will launch ```` with the + provided arguments and report the collected stats when it exits. + +Configuration +------------- +Collection is controlled by the environment variable ``HIPFILE_STATS_LEVEL``. + +===== ================================================= +Value Description +===== ================================================= +0 Disabled +1 Basic +2 Detailed (same as basic; reserved for future use) +===== ================================================= + +Stats Collected +--------------- +* Basic: Bytes read/written on the fastpath backend +* Basic: Bytes read/written on the fallback backend \ No newline at end of file