indmanager: Add a Debugging section in the README file

1 files changed, 21 insertions, 0 deletions

diff --git a/src/libs/indmanager/README b/src/libs/indmanager/README
index 4f9654d..caa5b00 100644
--- a/src/libs/indmanager/README
+++ b/src/libs/indmanager/README
@@ -137,6 +137,27 @@ Creation, Deletion, Modification
 and supports only one type per provider.
 Settings cannot be changed.
 
+Debugging
+~~~~~~~~~
+Indication manager is logging its job through standard CMPI trace facilities on
+a verbose level. That can be used to watch indications creation and sending to
+determine which side to debug in case indications are not working properly.
+Further errors like unreachable listener are usually logged through the same
+trace facitilies by CIMOM itself. Indication manager trace messages are always
+prefixed with "LMI indication manager" for easy grepping.
+
+As an example, the following options will make Pegasus to log trace messages in
+a file:
+
+  # cimserver daemon=false forceProviderProcesses=false traceLevel=5 \
+    traceFacility=File traceComponents=All
+
+Messages are usually logged in /var/lib/Pegasus/cache/trace/cimserver.trc (may
+vary on different systems) and simple grep will show you the actual progress:
+
+  # tail -f /var/lib/Pegasus/cache/trace/cimserver.trc | grep \
+    "LMI indication manager"
+
 Example
 ~~~~~~~
 Is not provided yet.