summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuangrongFu <fu.guangrong@zte.com.cn>2017-10-10 22:36:05 +0800
committerGuangrongFu <fu.guangrong@zte.com.cn>2017-10-10 22:36:05 +0800
commit9b7089e28a99fbce046dd72df260b8dc30de72d1 (patch)
tree7d6d302f34033484fc8f37afe25fe0c9ae9c7995
parentf5a25bfcba09ba5443e3c3bc130ded015b0e2b3a (diff)
Add Log and Diagnostic Info Doc
Change-Id: I8de0afde0569cb74497a1b35de0453b63fb45813 Issue-ID: HOLMES-66 Signed-off-by: GuangrongFu <fu.guangrong@zte.com.cn>
-rw-r--r--docs/platform/log-and-diagnostic-info.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst
index 4bda4ba..53527f5 100644
--- a/docs/platform/log-and-diagnostic-info.rst
+++ b/docs/platform/log-and-diagnostic-info.rst
@@ -4,11 +4,24 @@
Logging & Diagnostic Information
---------------------------------
-Description of how to interact with and diagnose problems with the components as delivered.
+In the Amsterdam release, the logs are kept inside the docekr containers, which means that you can get the log information only when the docker is still running.
Where to Access Information
^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Assume that the name of a running docker is *holmes-rule-mgmt*, the way to get the log is to run the command ``docker logs ${docker-name}`` in the command window:
+``sudo docker logs holmes-rule-mgmt``
+
+Then the logs will be displayed in the command window.
Error / Warning Messages
^^^^^^^^^^^^^^^^^^^^^^^^
+
+* Failed to initialize the SSL builder.: Could not create the SSL information for HTTPS calls.
+* Failed to fetch the DCAE configurations.: Could not get the configurations coded in the component specification files.
+* Failed to add rules.: Failed to deploy the rules distributed by CLAMP into Holmes.
+* Failed to publish the control loop message to DMaaP.: Errors occur while publishing messages to DMaaP.
+* Failed to read the API description file.: Could not find the swagger.json file.
+* An error occurrred while reading swagger.json.: An I/O Exception occurs while reading the swagger.json file.
+
+