summaryrefslogtreecommitdiffstats
path: root/docs/specs
diff options
context:
space:
mode:
authorBin Hu <bh526r@att.com>2018-08-23 14:00:58 +0000
committerGerrit Code Review <gerrit@onap.org>2018-08-23 14:00:58 +0000
commit334de580e582981302442b5313c2a6409a7e53d8 (patch)
treec79fec9dd364963669668c8230a3406af85dcfb2 /docs/specs
parent737457599e5e2cd5e93c2cdb59a244daf687d54a (diff)
parentc068678235b1a5b1902e26ec47ac66d8bf45ca6e (diff)
Merge "Onappylog library improvement"
Diffstat (limited to 'docs/specs')
-rw-r--r--docs/specs/logging_enablement.rst73
1 files changed, 51 insertions, 22 deletions
diff --git a/docs/specs/logging_enablement.rst b/docs/specs/logging_enablement.rst
index a717286..1ec3df7 100644
--- a/docs/specs/logging_enablement.rst
+++ b/docs/specs/logging_enablement.rst
@@ -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.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+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