Add logging and Diagnostics guide

Change-Id: I9aba2fd3f5226a241f768f946bdfbd10fa88dfce
issue-id: MULTICLOUD-86
Signed-off-by: liangke <lokyse@163.com>

1 files changed, 34 insertions, 0 deletions

diff --git a/docs/MultiCloud-Administrator-Guide.rst b/docs/MultiCloud-Administrator-Guide.rst
index 2f4a871..b18cc94 100644
--- a/docs/MultiCloud-Administrator-Guide.rst
+++ b/docs/MultiCloud-Administrator-Guide.rst
@@ -70,3 +70,37 @@ OpenStack Client to mange Multicloud. For example:
 
 will list the virtual machine in Multicloud’s backend OpenStack.
 
+
+Logging And Diagnostics
+=======================
+
+
+Logging file
+------------
+
+The logging file named "runtime_multivimbroker.log" located at /opt/multivimbroker/logs/ directory
+would record  INFO, WARN, ERROR and DEBUG level of information.
+The format string of logging is "%(asctime)s-%(funcName)s-%(filename)s-%(lineno)d-%(levelno)s-%(content string)s".
+If there are any issus happened in framework service, you are able to check ERROR level logging to
+diagnose the problem.
+The content of this file list as below:
+
+::
+
+    2017-11-03 07:03:31,646:[multivimbroker.pub.utils.restcall]:[restcall.py]-[63][DEBUG]:request=http://192.168.10.45:80/api/multicloud/v0/vmware_vio/identity/v2.0)
+    2017-11-03 07:08:38,020:[multivimbroker.pub.utils.restcall]:[restcall.py]-[63][DEBUG]:request=https://192.168.10.26:8443/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/vmware/vio)
+    2017-11-03 07:08:38,103:[multivimbroker.pub.utils.restcall]:[restcall.py]-[63][DEBUG]:request=http://192.168.10.45:80/api/multicloud/v0/vmware_vio/identity/v2.0)
+
+
+The stdout of framework service named "nohup.out" located at /opt/multivimbroker/ record each http request.
+The content of this file looks like as below:
+
+::
+
+    [25/Oct/2017 00:09:27] "POST /api/multicloud/v0/vmware_vio/identity/v2.0/tokens HTTP/1.0" 500 273
+    [25/Oct/2017 14:17:27] "POST /api/multicloud/v0/vmware_fake/identity/v2.0/tokens HTTP/1.0" 200 5389
+    [26/Oct/2017 23:44:13] "POST /api/multicloud/v0/vmware_vio/identity/v3/auth/tokens HTTP/1.0" 200 6213
+
+
+Each line compose with http method, url and response code, so you are able to check the response status of
+every http request.