summaryrefslogtreecommitdiffstats
path: root/doc/debugging/statedump.md
diff options
context:
space:
mode:
authorPoornima G <pgurusid@redhat.com>2016-01-22 11:44:21 -0500
committerKaleb KEITHLEY <kkeithle@redhat.com>2017-01-23 19:13:15 -0500
commitf2e7b6800b812e8bbc9bdbcea4c400a1784e31dc (patch)
tree2809f95a28204a4769e4dac07db8fe7b79a980f9 /doc/debugging/statedump.md
parent4008a48080b9910b9948c35892e762e91198d134 (diff)
downloadglusterfs-f2e7b6800b812e8bbc9bdbcea4c400a1784e31dc.tar.gz
glusterfs-f2e7b6800b812e8bbc9bdbcea4c400a1784e31dc.tar.xz
glusterfs-f2e7b6800b812e8bbc9bdbcea4c400a1784e31dc.zip
glusterd: add a cli command to trigger a statedump on a client
With this, we will be able to trigger statedumps on remote Gluster clients, mainly targetted for applications using libgfapi. Design: SIGUSR signal is the most comman way of taking a statedump in Gluster. But it cannot be used for libgfapi based processes, as the process loading the library might have already consumed SIGUSR signal. Hence going by the command way. One has to issue a Gluster command to initiate a statedump on the libgfapi based client. The command takes hostname and PID as an argument. All the glusterds in the cluster, check if they are connected to the specified hostname, and send an RPC request to all the connected clients from that hostname (via the mgmt connection). URL: http://review.gluster.org/16357 Change-Id: Icbe4d2f026b32a2c7d5535e1bfb2cdaaff042e91 BUG: 1169302 Signed-off-by: Poornima G <pgurusid@redhat.com> [ndevos: minor fixes and split patch in smaller pieces] Reviewed-on: https://review.gluster.org/9228 Reviewed-by: Niels de Vos <ndevos@redhat.com> Tested-by: Niels de Vos <ndevos@redhat.com> Smoke: Gluster Build System <jenkins@build.gluster.org> NetBSD-regression: NetBSD Build System <jenkins@build.gluster.org> Reviewed-by: Kaleb KEITHLEY <kkeithle@redhat.com> CentOS-regression: Gluster Build System <jenkins@build.gluster.org> Reviewed-by: Samikshan Bairagya <samikshan@gmail.com>
Diffstat (limited to 'doc/debugging/statedump.md')
-rw-r--r--doc/debugging/statedump.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/debugging/statedump.md b/doc/debugging/statedump.md
index 18437f1144..9939576e27 100644
--- a/doc/debugging/statedump.md
+++ b/doc/debugging/statedump.md
@@ -19,6 +19,19 @@ For quotad: `gluster volume statedump <volname> quotad`
For brick-processes files will be created in `statedump-directory` with name of the file as `hyphenated-brick-path.<pid>.dump.timestamp`. For all other processes it will be `glusterdump.<pid>.dump.timestamp`.
+For applications using libgfapi, `SIGUSR1` cannot be used, eg: smbd/libvirtd
+processes could have used the `SIGUSR1` signal already for other purposes.
+To generate statedump for the processes, using libgfapi, below command can be
+executed from one of the nodes in the gluster cluster to which the libgfapi
+application is connected to.
+
+ gluster volume statedump <volname> client <hostname>:<process id>
+
+The statedumps can be found in the `statedump-directory`, the name of the
+statedumps being `glusterdump.<pid>.dump.timestamp`. For a process there can be
+multiple such files created depending on the number of times the volume is
+accessed by the process (related to the number of `glfs_init()` calls).
+
##How to read statedump
We shall see snippets of each type of statedump.