X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fadmin-guide.rst;h=c2643f87cd1154e21db6f33ba5efc927e0d59825;hb=ce880216ec85aa12c1fda23c3abaf4bd16d9595d;hp=efa23b50352131636f28972f899c1ec429d1bb6b;hpb=0ab0fd64fc7e2705ee772c0b5ccaa18c0bd84db2;p=cps.git
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst
index efa23b503..c2643f87c 100644
--- a/docs/admin-guide.rst
+++ b/docs/admin-guide.rst
@@ -30,19 +30,18 @@ Logging Configuration
CPS Log pattern
---------------
-.. code-block:: java
+.. code-block::
{
- "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
+ "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
- "rest": "%message" // Execution time ...
}
@@ -51,7 +50,7 @@ Change logging level
- Curl command 1. Check current log level of "logging.level.org.onap.cps" if it is set to it's default value (INFO)
-.. code-block:: java
+.. code-block:: bash
curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
--header 'Content-Type: application/json; charset=utf-8'
@@ -69,7 +68,7 @@ Change logging level
.. note::
Below-mentioned endpoint will change the log level at runtime. After executing the curl command "effectiveLevel" will set and applied immediately without restarting CPS service.
-.. code-block:: java
+.. code-block:: bash
curl --location --request POST 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
--header 'Content-Type: application/json; charset=utf-8' \
@@ -81,7 +80,7 @@ Change logging level
- Curl command 3. Verify if log level of "logging.level.org.onap.cps" is changed from 'INFO' to 'DEBUG'
-.. code-block:: java
+.. code-block:: bash
curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
--header 'Content-Type: application/json; charset=utf-8'
@@ -110,7 +109,7 @@ Measure Execution Time of CPS Service
Execute CPS service that you want to calculate total elapsed time and log as shown below
-.. code-block:: xml
+.. code-block::
2022-01-28 18:39:17.679 DEBUG [cps-application,e17da1571e518c59,e17da1571e518c59] 11128 --- [tp1901272535-29] o.onap.cps.aop.CpsLoggingAspectService : Execution time of : DataspaceRepository.getByName() with argument[s] = [test42] having result = org.onap.cps.spi.entities.DataspaceEntity@68ded236 :: 205 ms
@@ -155,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 `__ |
- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
- | cps-temporal | `logback.xml `__ |
- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
- | ncmp-dmi-plugin | Not yet applicable to DMI-Plugin |
- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
+ +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
+ | cps-component-service-name | logback.xml location |
+ +================================+===============================================================================================================================================+
+ | cps-core | `logback-spring.xml `__ |
+ +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
+ | cps-temporal | `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:
@@ -198,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