summaryrefslogtreecommitdiffstats
path: root/src/man/lv/include/debug_levels_tools.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/man/lv/include/debug_levels_tools.xml')
-rw-r--r--src/man/lv/include/debug_levels_tools.xml77
1 files changed, 77 insertions, 0 deletions
diff --git a/src/man/lv/include/debug_levels_tools.xml b/src/man/lv/include/debug_levels_tools.xml
new file mode 100644
index 0000000..23f2f89
--- /dev/null
+++ b/src/man/lv/include/debug_levels_tools.xml
@@ -0,0 +1,77 @@
+<listitem>
+ <para>
+ SSSD supports two representations for specifying the debug level. The
+simplest is to specify a decimal value from 0-9, which represents enabling
+that level and all lower-level debug messages. The more comprehensive option
+is to specify a hexadecimal bitmask to enable or disable specific levels
+(such as if you wish to suppress a level).
+ </para>
+ <para>
+ Currently supported debug levels:
+ </para>
+ <para>
+ <emphasis>0</emphasis>, <emphasis>0x0010</emphasis>: Fatal
+failures. Anything that would prevent SSSD from starting up or causes it to
+cease running.
+ </para>
+ <para>
+ <emphasis>1</emphasis>, <emphasis>0x0020</emphasis>: Critical failures. An
+error that doesn't kill SSSD, but one that indicates that at least one major
+feature is not going to work properly.
+ </para>
+ <para>
+ <emphasis>2</emphasis>, <emphasis>0x0040</emphasis>: Serious failures. An
+error announcing that a particular request or operation has failed.
+ </para>
+ <para>
+ <emphasis>3</emphasis>, <emphasis>0x0080</emphasis>: Minor failures. These
+are the errors that would percolate down to cause the operation failure of
+2.
+ </para>
+ <para>
+ <emphasis>4</emphasis>, <emphasis>0x0100</emphasis>: Configuration settings.
+ </para>
+ <para>
+ <emphasis>5</emphasis>, <emphasis>0x0200</emphasis>: Function data.
+ </para>
+ <para>
+ <emphasis>6</emphasis>, <emphasis>0x0400</emphasis>: Trace messages for
+operation functions.
+ </para>
+ <para>
+ <emphasis>7</emphasis>, <emphasis>0x1000</emphasis>: Trace messages for
+internal control functions.
+ </para>
+ <para>
+ <emphasis>8</emphasis>, <emphasis>0x2000</emphasis>: Contents of
+function-internal variables that may be interesting.
+ </para>
+ <para>
+ <emphasis>9</emphasis>, <emphasis>0x4000</emphasis>: Extremely low-level
+tracing information.
+ </para>
+ <para>
+ <emphasis>10</emphasis>, <emphasis>0x10000</emphasis>: Even more low-level
+libldb tracing information. Almost never really required.
+ </para>
+ <para>
+ To log required bitmask debug levels, simply add their numbers together as
+shown in following examples:
+ </para>
+ <para>
+ <emphasis>Example</emphasis>: To log fatal failures, critical failures,
+serious failures and function data use 0x0270.
+ </para>
+ <para>
+ <emphasis>Example</emphasis>: To log fatal failures, configuration settings,
+function data, trace messages for internal control functions use 0x1310.
+ </para>
+ <para>
+ <emphasis>Note</emphasis>: The bitmask format of debug levels was introduced
+in 1.7.0.
+ </para>
+ <para>
+ <emphasis>Default</emphasis>: 0x0070 (i.e. fatal, critical and serious
+failures; corresponds to setting 2 in decimal notation)
+ </para>
+</listitem>