source: vendor/current/ctdb/doc/ctdb-statistics.7

Last change on this file was 988, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.3

File size: 14.2 KB
Line 
1'\" t
2.\" Title: ctdb-statistics
3.\" Author:
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 01/27/2016
6.\" Manual: CTDB - clustered TDB database
7.\" Source: ctdb
8.\" Language: English
9.\"
10.TH "CTDB\-STATISTICS" "7" "01/27/2016" "ctdb" "CTDB \- clustered TDB database"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31ctdb-statistics \- CTDB statistics output
32.SH "OVERALL STATISTICS"
33.PP
34CTDB maintains information about various messages communicated and some of the important operations per node\&. See the
35\fBctdb\fR(1)
36commands
37\fBstatistics\fR
38and
39\fBstatisticsreset\fR
40for displaying statistics\&.
41.SS "Example: ctdb statistics"
42.sp
43.if n \{\
44.RS 4
45.\}
46.nf
47CTDB version 1
48Current time of statistics : Fri Sep 12 13:32:32 2014
49Statistics collected since : (000 01:49:20) Fri Sep 12 11:43:12 2014
50 num_clients 6
51 frozen 0
52 recovering 0
53 num_recoveries 2
54 client_packets_sent 281293
55 client_packets_recv 296317
56 node_packets_sent 452387
57 node_packets_recv 182394
58 keepalive_packets_sent 3927
59 keepalive_packets_recv 3928
60 node
61 req_call 48605
62 reply_call 1
63 req_dmaster 23404
64 reply_dmaster 24917
65 reply_error 0
66 req_message 958
67 req_control 197513
68 reply_control 153705
69 client
70 req_call 130866
71 req_message 770
72 req_control 168921
73 timeouts
74 call 0
75 control 0
76 traverse 0
77 locks
78 num_calls 220
79 num_current 0
80 num_pending 0
81 num_failed 0
82 total_calls 130866
83 pending_calls 0
84 childwrite_calls 1
85 pending_childwrite_calls 0
86 memory_used 334490
87 max_hop_count 18
88 total_ro_delegations 2
89 total_ro_revokes 2
90 hop_count_buckets: 42816 5464 26 1 0 0 0 0 0 0 0 0 0 0 0 0
91 lock_buckets: 9 165 14 15 7 2 2 0 0 0 0 0 0 0 0 0
92 locks_latency MIN/AVG/MAX 0\&.000685/0\&.160302/6\&.369342 sec out of 214
93 reclock_ctdbd MIN/AVG/MAX 0\&.004940/0\&.004969/0\&.004998 sec out of 2
94 reclock_recd MIN/AVG/MAX 0\&.000000/0\&.000000/0\&.000000 sec out of 0
95 call_latency MIN/AVG/MAX 0\&.000006/0\&.000719/4\&.562991 sec out of 126626
96 childwrite_latency MIN/AVG/MAX 0\&.014527/0\&.014527/0\&.014527 sec out of 1
97
98.fi
99.if n \{\
100.RE
101.\}
102.SS "CTDB version"
103.PP
104Version of the ctdb protocol used by the node\&.
105.SS "Current time of statistics"
106.PP
107Time when the statistics are generated\&.
108.PP
109This is useful when collecting statistics output periodically for post\-processing\&.
110.SS "Statistics collected since"
111.PP
112Time when ctdb was started or the last time statistics was reset\&. The output shows the duration and the timestamp\&.
113.SS "num_clients"
114.PP
115Number of processes currently connected to CTDB\*(Aqs unix socket\&. This includes recovery daemon, ctdb tool and samba processes (smbd, winbindd)\&.
116.SS "frozen"
117.PP
1181 if the the databases are currently frozen, 0 otherwise\&.
119.SS "recovering"
120.PP
1211 if recovery is active, 0 otherwise\&.
122.SS "num_recoveries"
123.PP
124Number of recoveries since the start of ctdb or since the last statistics reset\&.
125.SS "client_packets_sent"
126.PP
127Number of packets sent to client processes via unix domain socket\&.
128.SS "client_packets_recv"
129.PP
130Number of packets received from client processes via unix domain socket\&.
131.SS "node_packets_sent"
132.PP
133Number of packets sent to the other nodes in the cluster via TCP\&.
134.SS "node_packets_recv"
135.PP
136Number of packets received from the other nodes in the cluster via TCP\&.
137.SS "keepalive_packets_sent"
138.PP
139Number of keepalive messages sent to other nodes\&.
140.PP
141CTDB periodically sends keepalive messages to other nodes\&. See
142KeepaliveInterval
143tunable in
144\fBctdb-tunables\fR(7)
145for more details\&.
146.SS "keepalive_packets_recv"
147.PP
148Number of keepalive messages received from other nodes\&.
149.SS "node"
150.PP
151This section lists various types of messages processed which originated from other nodes via TCP\&.
152.sp
153.it 1 an-trap
154.nr an-no-space-flag 1
155.nr an-break-flag 1
156.br
157.ps +1
158\fBreq_call\fR
159.RS 4
160.PP
161Number of REQ_CALL messages from the other nodes\&.
162.RE
163.sp
164.it 1 an-trap
165.nr an-no-space-flag 1
166.nr an-break-flag 1
167.br
168.ps +1
169\fBreply_call\fR
170.RS 4
171.PP
172Number of REPLY_CALL messages from the other nodes\&.
173.RE
174.sp
175.it 1 an-trap
176.nr an-no-space-flag 1
177.nr an-break-flag 1
178.br
179.ps +1
180\fBreq_dmaster\fR
181.RS 4
182.PP
183Number of REQ_DMASTER messages from the other nodes\&.
184.RE
185.sp
186.it 1 an-trap
187.nr an-no-space-flag 1
188.nr an-break-flag 1
189.br
190.ps +1
191\fBreply_dmaster\fR
192.RS 4
193.PP
194Number of REPLY_DMASTER messages from the other nodes\&.
195.RE
196.sp
197.it 1 an-trap
198.nr an-no-space-flag 1
199.nr an-break-flag 1
200.br
201.ps +1
202\fBreply_error\fR
203.RS 4
204.PP
205Number of REPLY_ERROR messages from the other nodes\&.
206.RE
207.sp
208.it 1 an-trap
209.nr an-no-space-flag 1
210.nr an-break-flag 1
211.br
212.ps +1
213\fBreq_message\fR
214.RS 4
215.PP
216Number of REQ_MESSAGE messages from the other nodes\&.
217.RE
218.sp
219.it 1 an-trap
220.nr an-no-space-flag 1
221.nr an-break-flag 1
222.br
223.ps +1
224\fBreq_control\fR
225.RS 4
226.PP
227Number of REQ_CONTROL messages from the other nodes\&.
228.RE
229.sp
230.it 1 an-trap
231.nr an-no-space-flag 1
232.nr an-break-flag 1
233.br
234.ps +1
235\fBreply_control\fR
236.RS 4
237.PP
238Number of REPLY_CONTROL messages from the other nodes\&.
239.RE
240.SS "client"
241.PP
242This section lists various types of messages processed which originated from clients via unix domain socket\&.
243.sp
244.it 1 an-trap
245.nr an-no-space-flag 1
246.nr an-break-flag 1
247.br
248.ps +1
249\fBreq_call\fR
250.RS 4
251.PP
252Number of REQ_CALL messages from the clients\&.
253.RE
254.sp
255.it 1 an-trap
256.nr an-no-space-flag 1
257.nr an-break-flag 1
258.br
259.ps +1
260\fBreq_message\fR
261.RS 4
262.PP
263Number of REQ_MESSAGE messages from the clients\&.
264.RE
265.sp
266.it 1 an-trap
267.nr an-no-space-flag 1
268.nr an-break-flag 1
269.br
270.ps +1
271\fBreq_control\fR
272.RS 4
273.PP
274Number of REQ_CONTROL messages from the clients\&.
275.RE
276.SS "timeouts"
277.PP
278This section lists timeouts occurred when sending various messages\&.
279.sp
280.it 1 an-trap
281.nr an-no-space-flag 1
282.nr an-break-flag 1
283.br
284.ps +1
285\fBcall\fR
286.RS 4
287.PP
288Number of timeouts for REQ_CALL messages\&.
289.RE
290.sp
291.it 1 an-trap
292.nr an-no-space-flag 1
293.nr an-break-flag 1
294.br
295.ps +1
296\fBcontrol\fR
297.RS 4
298.PP
299Number of timeouts for REQ_CONTROL messages\&.
300.RE
301.sp
302.it 1 an-trap
303.nr an-no-space-flag 1
304.nr an-break-flag 1
305.br
306.ps +1
307\fBtraverse\fR
308.RS 4
309.PP
310Number of timeouts for database traverse operations\&.
311.RE
312.SS "locks"
313.PP
314This section lists locking statistics\&.
315.sp
316.it 1 an-trap
317.nr an-no-space-flag 1
318.nr an-break-flag 1
319.br
320.ps +1
321\fBnum_calls\fR
322.RS 4
323.PP
324Number of completed lock calls\&. This includes database locks and record locks\&.
325.RE
326.sp
327.it 1 an-trap
328.nr an-no-space-flag 1
329.nr an-break-flag 1
330.br
331.ps +1
332\fBnum_current\fR
333.RS 4
334.PP
335Number of scheduled lock calls\&. This includes database locks and record locks\&.
336.RE
337.sp
338.it 1 an-trap
339.nr an-no-space-flag 1
340.nr an-break-flag 1
341.br
342.ps +1
343\fBnum_pending\fR
344.RS 4
345.PP
346Number of queued lock calls\&. This includes database locks and record locks\&.
347.RE
348.sp
349.it 1 an-trap
350.nr an-no-space-flag 1
351.nr an-break-flag 1
352.br
353.ps +1
354\fBnum_failed\fR
355.RS 4
356.PP
357Number of failed lock calls\&. This includes database locks and record locks\&.
358.RE
359.SS "total_calls"
360.PP
361Number of req_call messages processed from clients\&. This number should be same as client \-\-> req_call\&.
362.SS "pending_calls"
363.PP
364Number of req_call messages which are currenly being processed\&. This number indicates the number of record migrations in flight\&.
365.SS "childwrite_calls"
366.PP
367Number of record update calls\&. Record update calls are used to update a record under a transaction\&.
368.SS "pending_childwrite_calls"
369.PP
370Number of record update calls currently active\&.
371.SS "memory_used"
372.PP
373The amount of memory in bytes currently used by CTDB using talloc\&. This includes all the memory used for CTDB\*(Aqs internal data structures\&. This does not include the memory mapped TDB databases\&.
374.SS "max_hop_count"
375.PP
376The maximum number of hops required for a record migration request to obtain the record\&. High numbers indicate record contention\&.
377.SS "total_ro_delegations"
378.PP
379Number of readonly delegations created\&.
380.SS "total_ro_revokes"
381.PP
382Number of readonly delegations that were revoked\&. The difference between total_ro_revokes and total_ro_delegations gives the number of currently active readonly delegations\&.
383.SS "hop_count_buckets"
384.PP
385Distribution of migration requests based on hop counts values\&. Buckets are 1, < 4, < 8, < 16, < 32, < 64, < 128, < 256, < 512, ≥ 512\&.
386.SS "lock_buckets"
387.PP
388Distribution of record lock requests based on time required to obtain locks\&. Buckets are < 1ms, < 10ms, < 100ms, < 1s, < 2s, < 4s, < 8s, < 16s, < 32s, < 64s, ≥ 64s\&.
389.SS "locks_latency"
390.PP
391The minimum, the average and the maximum time (in seconds) required to obtain record locks\&.
392.SS "reclock_ctdbd"
393.PP
394The minimum, the average and the maximum time (in seconds) required to check if recovery lock is still held by recovery daemon when recovery mode is changed\&. This check is done in ctdb daemon\&.
395.SS "reclock_recd"
396.PP
397The minimum, the average and the maximum time (in seconds) required to check if recovery lock is still held by recovery daemon during recovery\&. This check is done in recovery daemon\&.
398.SS "call_latency"
399.PP
400The minimum, the average and the maximum time (in seconds) required to process a REQ_CALL message from client\&. This includes the time required to migrate a record from remote node, if the record is not available on the local node\&.
401.SS "childwrite_latency"
402.PP
403Default: 0
404.PP
405The minimum, the average and the maximum time (in seconds) required to update records under a transaction\&.
406.SH "DATABASE STATISTICS"
407.PP
408CTDB maintains per database statistics about important operations\&. See the
409\fBctdb\fR(1)
410command
411\fBdbstatistics\fR
412for displaying database statistics\&.
413.SS "Example: ctdb dbstatistics notify_index\&.tdb"
414.sp
415.if n \{\
416.RS 4
417.\}
418.nf
419DB Statistics: notify_index\&.tdb
420 ro_delegations 0
421 ro_revokes 0
422 locks
423 total 131
424 failed 0
425 current 0
426 pending 0
427 hop_count_buckets: 9890 5454 26 1 0 0 0 0 0 0 0 0 0 0 0 0
428 lock_buckets: 4 117 10 0 0 0 0 0 0 0 0 0 0 0 0 0
429 locks_latency MIN/AVG/MAX 0\&.000683/0\&.004198/0\&.014730 sec out of 131
430 Num Hot Keys: 3
431 Count:7 Key:2f636c75737465726673
432 Count:18 Key:2f636c757374657266732f64617461
433 Count:7 Key:2f636c757374657266732f646174612f636c69656e7473
434
435.fi
436.if n \{\
437.RE
438.\}
439.SS "DB Statistics"
440.PP
441Name of the database\&.
442.SS "ro_delegations"
443.PP
444Number of readonly delegations created in the database\&.
445.SS "ro_revokes"
446.PP
447Number of readonly delegations revoked\&. The difference in ro_delegations and ro_revokes indicates the currently active readonly delegations\&.
448.SS "locks"
449.PP
450This section lists locking statistics\&.
451.sp
452.it 1 an-trap
453.nr an-no-space-flag 1
454.nr an-break-flag 1
455.br
456.ps +1
457\fBtotal\fR
458.RS 4
459.PP
460Number of completed lock calls\&. This includes database locks and record locks\&.
461.RE
462.sp
463.it 1 an-trap
464.nr an-no-space-flag 1
465.nr an-break-flag 1
466.br
467.ps +1
468\fBfailed\fR
469.RS 4
470.PP
471Number of failed lock calls\&. This includes database locks and record locks\&.
472.RE
473.sp
474.it 1 an-trap
475.nr an-no-space-flag 1
476.nr an-break-flag 1
477.br
478.ps +1
479\fBcurrent\fR
480.RS 4
481.PP
482Number of scheduled lock calls\&. This includes database locks and record locks\&.
483.RE
484.sp
485.it 1 an-trap
486.nr an-no-space-flag 1
487.nr an-break-flag 1
488.br
489.ps +1
490\fBpending\fR
491.RS 4
492.PP
493Number of queued lock calls\&. This includes database locks and record locks\&.
494.RE
495.SS "hop_count_buckets"
496.PP
497Distribution of migration requests based on hop counts values\&. Buckets are 1, < 4, < 8, < 16, < 32, < 64, < 128, < 256, < 512, ≥ 512\&.
498.SS "lock_buckets"
499.PP
500Distribution of record lock requests based on time required to obtain locks\&. Buckets are < 1ms, < 10ms, < 100ms, < 1s, < 2s, < 4s, < 8s, < 16s, < 32s, < 64s, ≥ 64s\&.
501.SS "locks_latency"
502.PP
503The minimum, the average and the maximum time (in seconds) required to obtain record locks\&.
504.SS "Num Hot Keys"
505.PP
506Number of contended records determined by hop count\&. CTDB keeps track of top 10 hot records and the output shows hex encoded keys for the hot records\&.
507.SH "SEE ALSO"
508.PP
509\fBctdb\fR(1),
510\fBctdbd\fR(1),
511\fBctdb-tunables\fR(7),
512\m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
513.SH "AUTHOR"
514.br
515.PP
516This documentation was written by Amitay Isaacs, Martin Schwenke
517.SH "COPYRIGHT"
518.br
519Copyright \(co 2007 Andrew Tridgell, Ronnie Sahlberg
520.br
521.PP
522This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version\&.
523.PP
524This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
525.PP
526You should have received a copy of the GNU General Public License along with this program; if not, see
527\m[blue]\fB\%http://www.gnu.org/licenses\fR\m[]\&.
528.sp
Note: See TracBrowser for help on using the repository browser.