git.sur5r.net Git - openldap/blob - doc/guide/admin/monitoringslapd.sdf

   1 # Copyright 1999, The OpenLDAP Foundation, All Rights Reserved.
   2 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
   3 H1: Monitoring Slapd
   4
   5 Slapd supports a monitoring interface you can use to find out
   6 many useful bits of information about what slapd is currently
   7 doing, how many connections it has, how many threads are
   8 working, etc. You can access the monitor feature by doing a
   9 base object search of the SLAPD_MONITOR_DN from
  10 include/ldapconfig.h with any kind of valid filter (e.g.,
  11 "(objectclass=*)"). By default, this DN is set to "cn=monitor".
  12 You will get one entry returned to you, with the following
  13 attributes:
  14
  15 E: version: slapd <version> (<date>)
  16
  17 This attribute identifies the slapd server software by name,
  18 version, and build date, e.g., {{EX: slapd 3.3 (Thu May 21 14:19:03
  19 EDT 1996)}}
  20
  21 E: threads: <integer>
  22
  23 This attribute indicates the number of threads (operations)
  24 currently outstanding in slapd.
  25
  26 E: connection: <fd> : <opentime> : <opsinitiated> :
  27 E:      <opscompleted> : <binddn> : [ <rw> ]
  28
  29 This multi-valued attribute summarizes information for each
  30 open connection. The information given is {{EX: <fd>}}, the file
  31 descriptor; {{EX: <opentime>}}, the time the connection was opened
  32 in UTC format; {{EX: <opsinitiated>}}, the number of operations
  33 initiated over the connection; {{EX: <opscompleted>}}, the number
  34 of operations completed over the connection; {{EX: <binddn>}}, the
  35 DN currently bound to the connection; and optionally {{EX: <rw>}},
  36 indicating whether the connection is currently blocked for
  37 read or write..
  38
  39 E: currentconnections: <integer>
  40
  41 The current number of connections.
  42
  43 E: totalconnections: <integer>
  44
  45 The total number of connections handled by slapd since it
  46 started.
  47
  48 E: dtablesize: <integer>
  49
  50 The size of slapd's file descriptor table.
  51
  52 E: writewaiters: <integer>
  53
  54 The number of threads blocked waiting to write data to a
  55 client.
  56
  57 E: readwaiters: <integer>
  58
  59 The number of threads blocked waiting to read data from a
  60 client.
  61
  62 E: opsinitiated: <integer>
  63
  64 The total number of operations initiated by slapd since it
  65 started.
  66
  67 E: opscompleted: <integer>
  68
  69 The total number of operations completed by slapd since it
  70 started.
  71
  72 E: entriessent: <integer>
  73
  74 The total number of entries sent to clients by slapd since it
  75 started.
  76
  77 E: bytessent: <integer>
  78
  79 The total number of bytes sent to clients by slapd since it
  80 started.
  81
  82 E: currenttime: <UTC time>
  83
  84 Slapd's idea of the current time.
  85
  86 E: starttime: <integer>
  87
  88 The time slapd was started.
  89
  90 E: nbackends: <integer>
  91
  92 The number of backends currently being served by slapd.
  93
  94 E: concurrency: <integer>
  95
  96 Under Solaris 2.x only, an indication of the current level of
  97 thread concurrency.
  98
  99 Note that slapd takes a snapshot of this information and
 100 returns it to you. No attempt is made to ensure that the
 101 information is consistent (i.e., if an operation thread is
 102 modifying one of these things when the monitor thread is
 103 reading it, strange results could be returned).
 104
 105 You should be able to use any LDAP client to retrieve this
 106 information. Here's how you might do it using the
 107 {{I: ldapsearch}}(1) client:
 108
 109 E: ldapsearch -s base -b cn=monitor 'objectclass=*'
 110