X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fadmin-guide.rst;h=1c4d7455f05995353189296bd979a2d1873d08a7;hb=4f5671a73677db89bf21f6c1a9ff6a0585f5783e;hp=eeac013773a550d543d66401e194483a0aeefdd8;hpb=a59c24e665e30d5d47341b2c77cb65ae7118d849;p=cps.git diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index eeac01377..1c4d7455f 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -30,7 +30,7 @@ Logging Configuration CPS Log pattern --------------- -.. code-block:: java +.. code-block:: { @@ -50,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 @@ -68,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" @@ -80,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 @@ -97,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 @@ -109,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 @@ -154,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 `__ | - +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | 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 `__ | + +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | 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: @@ -173,7 +171,7 @@ Once CPS-Core is deployed, information related to the running instance of the ap .. code:: - http://:8081/manage/info/ + http://:8080/actuator/info/ Health ------ @@ -183,7 +181,7 @@ This also includes both the liveliness state and readiness state. .. code:: - http://:8081/manage/health/ + http://:8080/actuator/health/ Metrics ------- @@ -192,7 +190,19 @@ Prometheus Metrics can be checked at the following endpoint .. code:: - http://:8081/manage/prometheus + http://:8080/actuator/prometheus + +Hazelcast +--------- + +Hazelcast cluster state and health check can be seen using the below endpoints + +.. code:: + + http://:/hazelcast/health + http://:/hazelcast/rest/management/cluster/state + +See also : :ref:`cps_common_distributed_datastructures` Naming Validation -----------------