update link to upper-constraints.txt

[multicloud/framework.git] / docs / specs / logging_enablement.rst

diff --git a/docs/specs/logging_enablement.rst b/docs/specs/logging_enablement.rst
index a717286..4f4ac16 100644 (file)
--- a/docs/specs/logging_enablement.rst
+++ b/docs/specs/logging_enablement.rst
@@ -19,12 +19,12 @@ Problem Description
 
 So far the logging of multi-vim is not able to support customer configuration,
 handler context specific logging like
 
 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
+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.
 
 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
+.. _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.


@@ -38,13 +38,13 @@ The proposed change will include three parts.
 Filebeat container
 ------------------
 
 Filebeat container
 ------------------
 

-Logging architecture[Log_Architecture]_ use Filebeat collects logs from
+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.
 
 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
+.. _Log_Architecture: https://wiki.onap.org/display/DW/Logging+Architecture

 
 Tracing ID
 ----------
 
 Tracing ID
 ----------


@@ -73,25 +73,54 @@ 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.
 
 MDC context specific logging, able to
 change configuration at runtime, and make logging quite fast.
 

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+Supporting Python3 version
+--------------------------
+Right now, this library only has be used in Python2 version. Python2 will not been
+maintained after 2020, besides part of ONAP project have used python3 version.
+It's be better to support Python2 and Python3 version
+
+
+Markers
+-------
+Markers can be used to characterize log entries. They allow message that has
+a specific meaning to be cheaply and easily identified in logger output, without
+inherently unreliable schemes like scanning for magic strings in the text of each
+log message.
+Onap logging requires the emission of markers reporting entry, exit and invocation
+as the execution if requests pass between ONAP components. This information is used
+to generate a call graph.
+Useful and commonplace, See https://stackoverflow.com/questions/4165558/best-practices-for-using-markers-in-slf4j-logback
+
+
+colored terminal output
+-----------------------
+As we known, in log4j coloring is supported. It would be better to render logging messages in colors.
+Bash colors refer: https://en.wikipedia.org/wiki/ANSI_escape_code#Colors
+
+The standard colors(nosupport windows) list as below:
++---------------------+-------------------------+------------------------+
+| **Text color**      | **Hightlight color**    |  **Text Attribute**    |
++=====================+==================================================+
+|  Black              |   Black                 |   Normal               |
++---------------------+--------------------------------------------------+
+|  Red                |   Red                   |   Bold                 |
++---------------------+--------------------------------------------------+
+|  Green              |   Green                 |   Underline            |
++---------------------+--------------------------------------------------+
+|  Yellow             |   Yellow                |   Blink                |
++------------------------------------------------------------------------+
+|  Blue               |   Blue                  |   Invert               |
++------------------------------------------------------------------------+
+|  Purple             |   Purple                |   Hide                 |
++------------------------------------------------------------------------+
+|  Cyan               |   Cyan                  |                        |
++------------------------------------------------------------------------+
+|  White              |   White                 |                        |
++------------------------------------------------------------------------+
+
+
+Test
+====
+
+#. Unit tests with tox
+#. CSIT tests, verify marker label in logging message