git.sur5r.net Git - openldap/blob - servers/slapd/back-monitor/README

   1 back-monitor
   2
   3 Backend for monitoring the server's activity.  It must be explicitly
   4 enabled by configuring with `--enable-monitor' set; then it must be
   5 activated by placing in slapd.conf the configure directive
   6
   7 database        monitor
   8
   9 The suffix "cn=Monitor" is implicitly activated (it cannot be given
  10 as a suffix of the database as usually done for conventional backends).
  11
  12 The backend root is "cn=Monitor"; the first level entries represent
  13 the monitored subsystems.  It is being implemented in a modular way,
  14 to ease the addition of new subsystems.
  15 All the subsystems get a default "cn" attribute, represented by the
  16 subsystem's name, and they all have "top", "LDAPsubEntry" and
  17 "monitorSubEntry" objectclasses (the latter has not been defined yet,
  18 pending the design of the monitor schema and its registration under
  19 OpenLDAP's OID).
  20 Most of the sybsystems contain an additional depth level, represented
  21 by detailed item monitoring.
  22 All the entries undergo an update operation, if a related method is
  23 defined, prior to being returned.  Moreover, there's a mechanism to
  24 allow volatile entries to be defined, and generated on the fly when
  25 requested.  As an instance, the connection statistics are updated
  26 at each request, while each active connection data is created on the
  27 fly.
  28
  29 This document is in a very early stage of maturity and will probably
  30 be rewritten many times before the monitor backend is released.
  31
  32 Author: Pierangelo Masarati <ando@OpenLDAP.org>
  33