Skip to content

Commit a15653a

Browse files
committed
doc/cephfs: edit troubleshooting.rst
Edit the "Dynamic Debugging" section of doc/cephfs/troubleshooting.rst. Signed-off-by: Zac Dover <[email protected]> doc/cephfs: improve dynamic debugging section Signed-off-by: Venky Shankar <[email protected]>
1 parent 00f0c33 commit a15653a

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

doc/cephfs/troubleshooting.rst

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -375,9 +375,29 @@ and then reinstall it so that you have the latest version.
375375
Dynamic Debugging
376376
=================
377377

378-
You can enable dynamic debug against the CephFS module.
378+
Dynamic debugging for CephFS kernel driver allows to enable or disable debug
379+
logging. The kernel driver logs are written to the kernel ring buffer and can
380+
be examined using ``dmesg(1)`` utility. Debug logging is disabled by default
381+
because enabling debug logging can result in system slowness and a drop in I/O
382+
throughput.
379383

380-
Please see: https://github.com/ceph/ceph/blob/master/src/script/kcon_all.sh
384+
Enable dynamic debug against the CephFS module.
385+
386+
See: https://github.com/ceph/ceph/blob/master/src/script/kcon_all.sh
387+
388+
Note: Running the above script enables debug logging for the CephFS kernel
389+
driver, libceph, and the kernel RBD module. To enable debug logging for a
390+
specific component (for example, for the CephFS kernel driver), run a command of the following form:
391+
392+
.. prompt:: bash #
393+
394+
echo 'module ceph +p' > /sys/kernel/debug/dynamic_debug/control
395+
396+
To disable debug logging, run a command of the following form:
397+
398+
.. prompt:: bash #
399+
400+
echo 'module ceph -p' > /sys/kernel/debug/dynamic_debug/control
381401

382402
In-memory Log Dump
383403
==================

0 commit comments

Comments
 (0)