ctdb/utils/pmda/help

   1 #
   2 # Copyright (c) 2000-2004 Silicon Graphics, Inc.  All Rights Reserved.
   3 #
   4 # This program is free software; you can redistribute it and/or modify it
   5 # under the terms of the GNU General Public License as published by the
   6 # Free Software Foundation; either version 2 of the License, or (at your
   7 # option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful, but
  10 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11 # or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 # for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along
  15 # with this program; if not, write to the Free Software Foundation, Inc.,
  16 # 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 #
  18 # ctdb PMDA help file in the ASCII format
  19 #
  20 # lines beginning with a # are ignored
  21 # lines beginning @ introduce a new entry of the form
  22 #  @ metric_name oneline-text
  23 #  help test goes
  24 #  here over multiple lines
  25 #  ...
  26 #
  27 # the metric_name is decoded against the default PMNS -- as a special case,
  28 # a name of the form NNN.MM (for numeric NNN and MM) is interpreted as an
  29 # instance domain identification, and the text describes the instance domain
  30 #
  31 # blank lines before the @ line are ignored
  32 #
  33
  34 @ ctdb.num_clients number of clients connected to ctdbd
  35
  36 @ ctdb.frozen whether any databases are frozen
  37
  38 @ ctdb.recovering whether recovery is active
  39
  40 @ ctdb.client_packets_sent number of packets sent to all clients
  41
  42 @ ctdb.client_packets_recv number of packets received from all clients
  43
  44 @ ctdb.node_packets_sent number of packets sent to other nodes
  45
  46 @ ctdb.node_packets_recv number of packets received from other nodes
  47
  48 @ ctdb.keepalive_packets_sent number of keepalive packets sent to other nodes
  49
  50 @ ctdb.keepalive_packets_recv number of keepalive packets received from other nodes
  51
  52 @ ctdb.node.req_call number of node CTDB_REQ_CALL packets handled
  53
  54 @ ctdb.node.reply_call number of node CTDB_REPLY_CALL packets handled
  55
  56 @ ctdb.node.req_dmaster number of node CTDB_REQ_DMASTER packets handled
  57
  58 @ ctdb.node.reply_dmaster number of node CTDB_REPLY_DMASTER packets handled
  59
  60 @ ctdb.node.reply_error number of node CTDB_REPLY_ERROR packets handled
  61
  62 @ ctdb.node.req_message number of node CTDB_REQ_MESSAGE packets handled
  63
  64 @ ctdb.node.req_control number of node CTDB_REQ_CONTROL packets handled
  65
  66 @ ctdb.node.reply_control number of node CTDB_REPLY_CONTROL packets handled
  67
  68 @ ctdb.client.req_call number of client CTDB_REQ_CALL packets handled
  69
  70 @ ctdb.client.req_message number of client CTDB_REQ_MESSAGE packets handled
  71
  72 @ ctdb.client.req_control number of client CTDB_REQ_CONTROL packets handled
  73
  74 @ ctdb.timeouts.call (counter not implemented) number of call timeouts
  75
  76 @ ctdb.timeouts.control number of node control message request timeouts awaiting reply
  77
  78 @ ctdb.timeouts.traverse number of database traversal timeouts
  79
  80 @ ctdb.total_calls total number of client ctdb request calls received
  81
  82 @ ctdb.pending_calls total number of client ctdb request calls in progress
  83
  84 @ ctdb.lockwait_calls number of tdb chainlock lockwait calls
  85
  86 @ ctdb.pending_lockwait_calls number of lockwait calls waiting for a lock
  87
  88 @ ctdb.childwrite_calls number of childwrite calls
  89
  90 @ ctdb.pending_childwrite_calls number of childwrite calls in progress
  91
  92 @ ctdb.memory_used total size of the ctdbd null talloc pool
  93
  94 @ ctdb.max_hop_count maximum hops performed by a CTDB_REQ_CALL packet
  95
  96 @ ctdb.max_reclock_ctdbd maximum recovery lock latency during setrecmode
  97
  98 @ ctdb.max_reclock_recd maximum recovery lock latency as reported by the recovery process
  99
 100 @ ctdb.max_call_latency maximum time spent handling a client request call
 101
 102 @ ctdb.max_lockwait_latency maximum time spent waiting for a tdb chainlock
 103
 104 @ ctdb.max_childwrite_latency maximum time spent performing a childwrite
 105
 106 @ ctdb.num_recoveries number of recoveries finished