From ee4e903b9005d33a9212c259b4cb2f381a3f0f30 Mon Sep 17 00:00:00 2001 From: Gavin Henry Date: Thu, 5 Feb 2009 12:39:31 +0000 Subject: [PATCH] (ITS#5904) Docs: admin guide describes log levels inconsistently --- doc/guide/admin/runningslapd.sdf | 46 +++++++++++++++------------- doc/guide/admin/slapdconf2.sdf | 12 +++++++- doc/guide/admin/slapdconfig.sdf | 51 +++++++++++++++++++++----------- 3 files changed, 69 insertions(+), 40 deletions(-) diff --git a/doc/guide/admin/runningslapd.sdf b/doc/guide/admin/runningslapd.sdf index 68b32be714..8765f1751b 100644 --- a/doc/guide/admin/runningslapd.sdf +++ b/doc/guide/admin/runningslapd.sdf @@ -80,35 +80,39 @@ debugging levels are !block table; colaligns="RL"; align=Center; \ title="Table 7.1: Debugging Levels" -Level Description --1 enable all debugging -0 no debugging -1 trace function calls -2 debug packet handling -4 heavy trace debugging -8 connection management -16 print out packets sent and received -32 search filter processing -64 configuration file processing -128 access control list processing -256 stats log connections/operations/results -512 stats log entries sent -1024 print communication with shell backends -2048 print entry parsing debugging +Level Keyword Description +-1 Any enable all debugging +0 no debugging +1 Trace trace function calls +2 Packets debug packet handling +4 Args heavy trace debugging +8 Conns connection management +16 BER print out packets sent and received +32 Filter search filter processing +64 Config configuration processing +128 ACL access control list processing +256 Stats stats log connections/operations/results +512 Stats2 stats log entries sent +1024 Shell print communication with shell backends +2048 Parse print entry parsing debugging +4096 Cache database cache processing +8192 Index database indexing +16384 Sync syncrepl consumer processing +32768 None only messages that get logged whatever log level is set !endblock -You may enable multiple levels by specifying the debug option -once for each desired level. Or, since debugging levels are -additive, you can do the math yourself. That is, if you want -to trace function calls and watch the config file being +Log levels may be specified as integers or by keyword. You may enable multiple +levels by specifying the debug option once for each desired level. Or, since +debugging levels are additive, you can do the math yourself. That is, if you +want to trace function calls and watch the config file being processed, you could set level to the sum of those two levels (in this case, {{EX: -d 65}}). Or, you can let slapd do the math, (e.g. {{EX: -d 1 -d 64}}). Consult {{F: }} for more details. -Note: slapd must have been compiled with {{EX:-DLDAP_DEBUG}} +Note: slapd must have been compiled with {{EX:--enable-debug}} defined for any debugging information beyond the two stats levels -to be available. +to be available (the default). H2: Starting slapd diff --git a/doc/guide/admin/slapdconf2.sdf b/doc/guide/admin/slapdconf2.sdf index 8b233f8824..512eabc05e 100644 --- a/doc/guide/admin/slapdconf2.sdf +++ b/doc/guide/admin/slapdconf2.sdf @@ -194,9 +194,10 @@ Level Keyword Description 4096 Cache database cache processing 8192 Index database indexing 16384 Sync syncrepl consumer processing +32768 None only messages that get logged whatever log level is set !endblock -\Example: +\Examples: E: olcLogLevel: -1 @@ -207,10 +208,19 @@ E: olcLogLevel: Conns Filter Just log the connection and search filter processing. +E: olcLogLevel: None + +Log those messages that are logged regardless of the configured loglevel. This +differs from setting the log level to 0, when no logging occurs. At least the +{{EX:None}} level is required to have high priority messages logged. + \Default: E: olcLogLevel: Stats +Basic stats logging is configured by default. However, if no olcLogLevel is +defined, no logging occurs (equivalent to a 0 level). + H4: olcReferral diff --git a/doc/guide/admin/slapdconfig.sdf b/doc/guide/admin/slapdconfig.sdf index e3180088f1..94c88a0ebb 100644 --- a/doc/guide/admin/slapdconfig.sdf +++ b/doc/guide/admin/slapdconfig.sdf @@ -136,36 +136,51 @@ and operation statistics should be syslogged (currently logged to the {{syslogd}}(8) {{EX:LOG_LOCAL4}} facility). You must have configured OpenLDAP {{EX:--enable-debug}} (the default) for this to work (except for the two statistics levels, which are always -enabled). Log levels are additive. To display what numbers -correspond to what kind of debugging, invoke slapd with {{EX:-d?}} +enabled). Log levels may be specified as integers or by keyword. +Multiple log levels may be used and the levels are additive. To display what +numbers correspond to what kind of debugging, invoke slapd with {{EX:-d?}} or consult the table below. The possible values for are: !block table; colaligns="RL"; align=Center; \ title="Table 6.1: Debugging Levels" -Level Description --1 enable all debugging -0 no debugging -1 trace function calls -2 debug packet handling -4 heavy trace debugging -8 connection management -16 print out packets sent and received -32 search filter processing -64 configuration file processing -128 access control list processing -256 stats log connections/operations/results -512 stats log entries sent -1024 print communication with shell backends -2048 print entry parsing debugging +Level Keyword Description +-1 Any enable all debugging +0 no debugging +1 Trace trace function calls +2 Packets debug packet handling +4 Args heavy trace debugging +8 Conns connection management +16 BER print out packets sent and received +32 Filter search filter processing +64 Config configuration processing +128 ACL access control list processing +256 Stats stats log connections/operations/results +512 Stats2 stats log entries sent +1024 Shell print communication with shell backends +2048 Parse print entry parsing debugging +4096 Cache database cache processing +8192 Index database indexing +16384 Sync syncrepl consumer processing +32768 None only messages that get logged whatever log level is set !endblock -\Example: +\Examples: E: loglevel -1 This will cause lots and lots of debugging information to be logged. +E: loglevel Conns Filter + +Just log the connection and search filter processing. + +E: loglevel None + +Log those messages that are logged regardless of the configured loglevel. This +differs from setting the log level to 0, when no logging occurs. At least the +{{EX:None}} level is required to have high priority messages logged. + \Default: E: loglevel 256 -- 2.39.5