Code Review / cps.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Merge "CM SUBSCRIPTION: add new subscription for non existing xpath"
[cps.git] / docs / admin-guide.rst
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst
index efa23b5..1c4d745 100644 (file)
--- a/docs/admin-guide.rst
+++ b/docs/admin-guide.rst
@@ -30,19 +30,18 @@ Logging Configuration
 CPS Log pattern
 ---------------
 
-.. code-block:: java
+.. code-block::
 
    <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
+         "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 ...
        }
    </pattern>
 
@@ -51,9 +50,9 @@ 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' \
+    curl --location --request GET 'http://{cps-service-name:cps-port}/actuator/loggers/org.onap.cps' \
     --header 'Content-Type: application/json; charset=utf-8'
 
     Response body : HTTP Status 200
@@ -69,9 +68,9 @@ 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' \
+    curl --location --request POST 'http://{cps-service-name:cps-port}/actuator/loggers/org.onap.cps' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data-raw '{
                     "configuredLevel": "DEBUG"
@@ -81,9 +80,9 @@ 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' \
+    curl --location --request GET 'http://{cps-service-name:cps-port}/actuator/loggers/org.onap.cps' \
     --header 'Content-Type: application/json; charset=utf-8'
 
     Response body : HTTP Status 200
@@ -98,7 +97,7 @@ Location of log files
 ---------------------
 By default, Spring Boot will only log to the console and will not write log files.
 
-.. image:: images/cps-service-console.JPG
+.. image:: _static/cps-service-console.JPG
   :width: 700
   :alt: CPS service console
 
@@ -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,13 @@ 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>`__       |
+    +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
+    | 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:
@@ -174,7 +171,7 @@ Once CPS-Core is deployed, information related to the running instance of the ap
 
 .. code::
 
-    http://<cps-component-service-name>:8081/manage/info/
+    http://<cps-component-service-name>:8080/actuator/info/
 
 Health
 ------
@@ -184,7 +181,7 @@ This also includes both the liveliness state and readiness state.
 
 .. code::
 
-    http://<cps-component-service-name>:8081/manage/health/
+    http://<cps-component-service-name>:8080/actuator/health/
 
 Metrics
 -------
@@ -193,12 +190,24 @@ Prometheus Metrics can be checked at the following endpoint
 
 .. code::
 
-    http://<cps-component-service-name>:8081/manage/prometheus
+    http://<cps-component-service-name>:8080/actuator/prometheus
+
+Hazelcast
+---------
+
+Hazelcast cluster state and health check can be seen using the below endpoints
+
+.. code::
+
+    http://<cps-component-service-name>:<member-port>/hazelcast/health
+    http://<cps-component-service-name>:<member-port>/hazelcast/rest/management/cluster/state
+
+See also : :ref:`cps_common_distributed_datastructures`
 
 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"