summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2012-12-11 01:24:35 -0600
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2012-12-11 01:24:35 -0600
commit1209c71f57c6bc566f194598d137e3619006888f (patch)
tree9f28e91d362ee8eaf80e059a23033dfecd0115e4 /doc
parent493938b7748be627e67ba37f87cc7d90d950ee1b (diff)
downloadbcfg2-1209c71f57c6bc566f194598d137e3619006888f.tar.gz
bcfg2-1209c71f57c6bc566f194598d137e3619006888f.tar.bz2
bcfg2-1209c71f57c6bc566f194598d137e3619006888f.zip
doc: added docs about setting debug level
Diffstat (limited to 'doc')
-rw-r--r--doc/help/troubleshooting.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt
index 8a8d00970..35c1e93a2 100644
--- a/doc/help/troubleshooting.txt
+++ b/doc/help/troubleshooting.txt
@@ -34,6 +34,31 @@ Review server log messages
The bcfg2-server process logs to syslog facility LOG_DAEMON. The server
produces a series of messages upon a variety of events and errors.
+The server also supports two XML-RPC methods that can be used
+to turn up the debug level in a live server:
+
+* ``toggle_debug``: Turn debug on or off, depending on the current
+ setting.
+* ``set_debug``: Turn debug explicitly on or off.
+
+These can be called with :ref:`bcfg2-admin xcmd <server-admin-xcmd>`,
+e.g.::
+
+ bcfg2-admin xcmd toggle_debug
+ bcfg2-admin xcmd set_debug true
+
+Each plugin also supports these two methods, which can be used to set
+the debug level individually on a given plugin, e.g.::
+
+ bcfg2-admin xcmd Packages.set_debug true
+ bcfg2-admin xcmd Probes.toggle_debug
+
+Finally, the File Activity Monitor has its own analogue to these two
+methods, for setting the debug level of the FAM:
+
+ bcfg2-admin xcmd toggle_fam_debug
+ bcfg2-admin xcmd set_fam_debug false
+
Check if all repository XML files conform to schemas
====================================================