X-Git-Url: https://gerrit.onap.org/r/gitweb?p=multicloud%2Fframework.git;a=blobdiff_plain;f=docs%2Fspecs%2Flogging_enablement.rst;fp=docs%2Fspecs%2Flogging_enablement.rst;h=a717286b3655541d791d1611fb34047119d7f041;hp=5fb639e6b291b0580621a3dd1fec4bc545276ccc;hb=b3e79cc6ebba2898e201426b59c1bc8caa347a6a;hpb=a47bd5937ca0a7dd88533c05cbf8e67010ab56f2

diff --git a/docs/specs/logging_enablement.rst b/docs/specs/logging_enablement.rst
index 5fb639e..a717286 100644
--- a/docs/specs/logging_enablement.rst
+++ b/docs/specs/logging_enablement.rst
@@ -6,8 +6,10 @@
 Multi-Vim logging
 =================
 
-The purpose of logging is to generate machine-readable, indexable output logs and support to trace
-requests through sub-component, it need to ship logs to logging enhancement project a centralized
+The purpose of logging is to generate machine-readable, indexable output logs
+and support to trace
+requests through sub-component, it need to ship logs to logging enhancement
+project a centralized
 logging analysis system capturing diagnostic information.
 
 
@@ -15,13 +17,17 @@ logging analysis system capturing diagnostic information.
 Problem Description
 ===================
 
-So far the logging of multi-vim is not able to support customer configuration, handler context specific logging like
-MDC[MDC_Document]_, also it dose't propagate transaction-ID in REST headers which is critical to tracing request.
-There are 4 python containers in oom project need to configure filebeat container for shipping logs.
+So far the logging of multi-vim is not able to support customer configuration,
+handler context specific logging like
+MDC[MDC_Document]_, also it dose't propagate transaction-ID in REST headers
+which is critical to tracing request.
+There are 4 python containers in oom project need to configure filebeat
+container for shipping logs.
 
 .. [MDC_Document] https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-MDCs
 
-In addition the current logging is very difficult to understand behavior and performance.
+In addition the current logging is very difficult to understand behavior
+and performance.
 
 
 Proposed Change
@@ -32,8 +38,10 @@ The proposed change will include three parts.
 Filebeat container
 ------------------
 
-Logging architecture[Log_Architecture]_ use Filebeat collects logs from multi-vim containers and ships them to the
-centralized logging stack. To enable this feature it need to add Filebeat container in multi-vim pod that was
+Logging architecture[Log_Architecture]_ use Filebeat collects logs from
+multi-vim containers and ships them to the
+centralized logging stack. To enable this feature it need to add Filebeat
+container in multi-vim pod that was
 deployed by OOM, as well Yaml file will be used to configure Filebeat.
 
 .. [Log_Architecture] https://wiki.onap.org/display/DW/Logging+Architecture
@@ -41,12 +49,15 @@ deployed by OOM, as well Yaml file will be used to configure Filebeat.
 Tracing ID
 ----------
 
-ONAP logging uses a global unique "RequestID"[RequestID_Document]_ in logging to track the processing of each request
-across all the components, multi-vim will receive this id from http header by vary "X-TransactionID", then record it
-in logs.
-Meanwhile single component should generate a InvocationID that records the relationship between RequestID
-and InvocationID for proper tracing. So Mulit-vim will set unique InvocationID for each single request,also output it
+ONAP logging uses a global unique "RequestID"[RequestID_Document]_ in logging
+to track the processing of each request
+across all the components, multi-vim will receive this id from http header
+by vary "X-TransactionID", then record it
 in logs.
+Meanwhile single component should generate a InvocationID that records the
+relationship between RequestID
+and InvocationID for proper tracing. So Mulit-vim will set unique InvocationID
+for each single request,also output it in logs.
 
 .. [RequestID_Document] https://wiki.onap.org/pages/viewpage.action?pageId=20087036#ONAPApplicationLoggingGuidelinesv1.2(Beijing)-MDC-RequestID
 
@@ -54,9 +65,12 @@ in logs.
 python AOP logging library
 --------------------------
 
-Currently logging enhancement project just has java AOP logging library, For multi-vim which based on python need
-a python version. The basic feature of AOP logging library could provide customer configuration include retention
-policy、output location、text output format、message level and so on, support MDC context specific logging, able to
+Currently logging enhancement project just has java AOP logging library, For
+multi-vim which based on python need
+a python version. The basic feature of AOP logging library could provide
+customer configuration include retention
+policy、output location、text output format、message level and so on, support
+MDC context specific logging, able to
 change configuration at runtime, and make logging quite fast.