ITS#4780 plug leak

[openldap] / servers / slapd / back-monitor / README

diff --git a/servers/slapd/back-monitor/README b/servers/slapd/back-monitor/README
index 298c7f3a0aea10871db8f0be5ae337b5ee5c4ba3..21d7b868f2ef28d57aaa297815d6aeaaf9298248 100644 (file)
--- a/servers/slapd/back-monitor/README
+++ b/servers/slapd/back-monitor/README
@@ -20,7 +20,7 @@ configure directive
 The suffix "cn=Monitor" is implicitly activated (it cannot be given
 as a suffix of the database as usually done for conventional backends).
 Note that the "cn=Monitor" naming context appears in the rootDSE
-(FIXME: do we really want this?)
+in the attribute monitorContext
 
 A bind operation is provided; at present it allows to bind as the
 backend rootdn.  As a result, the backend supports the rootdn/rootpw 
@@ -39,11 +39,9 @@ to ease the addition of new subsystems.
 SCHEMA
 
 All the subsystems get a default "cn" attribute, represented by the
-subsystem's name, and they all have "top", "LDAPsubEntry" and
-"monitorSubEntry" objectclasses (the latter has not been defined yet,
-pending the design of the monitor schema and its registration under
-OpenLDAP's OID).
-At present "extensibleObject" is used, and the "description" attribute 
+subsystem's name, and they all have "top", "monitor" and "extensibleObject"
+objectclasses.
+"extensibleObject" is used, and the "description" attribute 
 is used to hold the monitor information of each entry.
 
 
@@ -83,31 +81,19 @@ partially useful information is provided.
 
 The subsystems are:
 
-       Listener
-       Databases
        Backends
-       Threads
-       SASL
-       TLS
        Connections
-       Read Waiters
-       Write Waiters
+       Databases
+       Listener
        Log
-
-
-
-LISTENER SUBSYSTEM
-
-Currently empty, it will presumably contain the description of the
-devices the server is currently listening on
-
-
-
-DATABASES SUBSYSTEM
-
-The main entry contains the naming context of each configured database; 
-the subentries contain, for each database, the type and the naming
-context.
+       Operations
+       Overlays
+       SASL
+       Statistics
+       Threads
+       Time
+       TLS
+       Read/Write Waiters
 
 
 
@@ -120,43 +106,29 @@ backends are enabled.
 
 
 
-THREADS SUBSYSTEM
-
-It contains the maximum number of threads enabled at startup and the 
-current backload.
-
-
-
-SASL
-
-Currently empty.
-
-
-
-TLS
-
-Currently empty.
-
-
-
 CONNECTIONS
 
 The main entry is empty; it should contain some statistics on the number 
 of connections.
 Dynamic subentries are created for each open connection, with stats on
 the activity on that connection (the format will be detailed later).
+There are two special subentries that show the number of total and
+current connections respectively.
 
 
 
-READ WAITERS SUBSYSTEM
+DATABASES SUBSYSTEM
 
-It contains the number of current read waiters.
+The main entry contains the naming context of each configured database; 
+the subentries contain, for each database, the type and the naming
+context.
 
 
 
-WRITE WAITERS SUBSYSTEM
+LISTENER SUBSYSTEM
 
-It contains the number of current write waiters.
+It contains the description of the devices the server is currently 
+listening on
 
 
 
@@ -186,6 +158,80 @@ messages are sent to the syslog device.
 
 
 
+OPERATIONS SUBSYSTEM
+
+It shows some statistics on the operations performed by the server:
+
+       Initiated
+       Completed
+
+and for each operation type, i.e.:
+
+       Bind
+        Unbind
+        Add
+        Delete
+        Modrdn
+        Modify
+        Compare
+        Search
+        Abandon
+        Extended
+
+
+
+OVERLAYS SUBSYSTEM
+
+The main entry contains the type of overlays available at run-time;
+the subentries, for each overlay, contain the type of the overlay.
+It should also contain the modules that have been loaded if dynamic 
+overlays are enabled.
+
+
+
+SASL
+
+Currently empty.
+
+
+
+STATISTICS SUBSYSTEM
+
+It shows some statistics on the data sent by the server:
+
+       Bytes
+       PDU
+       Entries
+       Referrals
+
+
+
+THREADS SUBSYSTEM
+
+It contains the maximum number of threads enabled at startup and the 
+current backload.
+
+
+
+TIME SUBSYSTEM
+
+It contains two subentries with the start time and the current time 
+of the server.
+
+
+
+TLS
+
+Currently empty.
+
+
+
+READ/WRITE WAITERS SUBSYSTEM
+
+It contains the number of current read waiters.
+
+
+
 NOTES
 
 This document is in a very early stage of maturity and will