Code Review / cps.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Merge "API versioning supported and added different versions for POST APIs"
[cps.git] / docs / admin-guide.rst
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst
index 1bc7f4f..a7439ef 100644 (file)
--- a/docs/admin-guide.rst
+++ b/docs/admin-guide.rst
@@ -33,17 +33,16 @@ CPS Log pattern
 .. code-block:: java
 
    <pattern>
-          {
-            "timestamp" : "%timestamp", // 2022-01-28 18:39:17.768
-            "severity": "%level",   // DEBUG
-            "service": "${springAppName}",  // cps-application
-            "trace": "${TraceId}", // e17da1571e518c59
-            "span": "${SpanId}", // e17da1571e518c59
-            "pid": "${PID}", //11128
-            "thread": "%thread", //tp1901272535-29
-            "class": "%logger{40}", .// o.onap.cps.aop.CpsLoggingAspectService
-            "rest": "%message" // Execution time ...
-          }
+       {
+         "logTimeStamp" : "%timestamp", // 2022-01-28 18:39:17.768
+         "logLevel": "%level",   // DEBUG
+         "principalId": "%userId",    // cpsuser
+         "serviceName": "${springAppName}",  // cps-application
+         "message":"%message",  // Execution time ...
+         "processId": "${PID}", //11128
+         "threadName": "%thread", //tp1901272535-29
+         "class": "%logger{40}", .// o.onap.cps.aop.CpsLoggingAspectService
+       }
    </pattern>
 
 Change logging level
@@ -63,6 +62,7 @@ Change logging level
         "effectiveLevel": "INFO"
     }
 
+
 - Curl command 2. Change logging level of "logging.level.org.onap.cps" to "DEBUG"
 
 .. note::
@@ -92,6 +92,7 @@ Change logging level
     "effectiveLevel": "DEBUG"
     }
 
+
 Location of log files
 ---------------------
 By default, Spring Boot will only log to the console and will not write log files.
@@ -135,6 +136,7 @@ Logging & Diagnostics
 
 General Guidelines
 ------------------
+
 CPS-Core logs are sent to `STDOUT` in order to leverage the Kubernetes logging architecture.
 
 These logs are available using the following command:
@@ -152,15 +154,15 @@ loggers log level
 
 Logger configuration is provided as a chart resource :
 
-    +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-    | cps-component-service-name     | logback.xml location                                                                                                            |
-    +================================+=================================================================================================================================+
-    | cps-core                       | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/resources/config/logback.xml>`_        |
-    +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-    | cps-temporal                   | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`_    |
-    +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-    | ncmp-dmi-plugin                | Not yet applicable to DMI-Plugin                                                                                                |
-    +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+    +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
+    | cps-component-service-name     | logback.xml location                                                                                                                          |
+    +================================+===============================================================================================================================================+
+    | cps-core                       | `logback-spring.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/resources/config/logback-spring.xml>`__       |
+    +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
+    | cps-temporal                   | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`__                 |
+    +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
+    | ncmp-dmi-plugin                | Not yet applicable to DMI-Plugin                                                                                                              |
+    +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
 
 .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning
 .. _cps_common_monitoring:
@@ -195,7 +197,7 @@ Prometheus Metrics can be checked at the following endpoint
 Naming Validation
 -----------------
 
-As part of the Jakarta 3.1.0 release, CPS has added validation to the names of the following components:
+As part of the Kohn 3.1.0 release, CPS has added validation to the names of the following components:
 
     - Dataspace names
     - Schema Set names
"cps"