1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2021-2022 Nordix Foundation
5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
19 Default logging level of "logging.level.org.onap.cps" is set to "INFO".
37 "logTimeStamp" : "%timestamp", // 2022-01-28 18:39:17.768
38 "logLevel": "%level", // DEBUG
39 "principalId": "%userId", // cpsuser
40 "serviceName": "${springAppName}", // cps-application
41 "message":"%message", // Execution time ...
42 "processId": "${PID}", //11128
43 "threadName": "%thread", //tp1901272535-29
44 "class": "%logger{40}", .// o.onap.cps.aop.CpsLoggingAspectService
51 - Curl command 1. Check current log level of "logging.level.org.onap.cps" if it is set to it's default value (INFO)
55 curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
56 --header 'Content-Type: application/json; charset=utf-8'
58 Response body : HTTP Status 200
61 "configuredLevel": "INFO",
62 "effectiveLevel": "INFO"
66 - Curl command 2. Change logging level of "logging.level.org.onap.cps" to "DEBUG"
69 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.
73 curl --location --request POST 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
74 --header 'Content-Type: application/json; charset=utf-8' \
76 "configuredLevel": "DEBUG"
79 Response body : HTTP Status 204
81 - Curl command 3. Verify if log level of "logging.level.org.onap.cps" is changed from 'INFO' to 'DEBUG'
85 curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
86 --header 'Content-Type: application/json; charset=utf-8'
88 Response body : HTTP Status 200
91 "configuredLevel": "DEBUG",
92 "effectiveLevel": "DEBUG"
98 By default, Spring Boot will only log to the console and will not write log files.
100 .. image:: images/cps-service-console.JPG
102 :alt: CPS service console
104 Measure Execution Time of CPS Service
105 -------------------------------------
108 Make sure effective log level of "logging.level.org.onap.cps" is 'DEBUG'. This can be verified by executing curl command 3.
110 Execute CPS service that you want to calculate total elapsed time and log as shown below
114 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
116 2022-01-28 18:39:17.726 DEBUG [cps-application,e17da1571e518c59,e17da1571e518c59] 11128 --- [tp1901272535-29] o.onap.cps.aop.CpsLoggingAspectService : Execution time of : AnchorRepository.getByDataspaceAndName() with argument[s] = [org.onap.cps.spi.entities.DataspaceEntity@68ded236, bookstore] having result = org.onap.cps.spi.entities.AnchorEntity@71c47fb1 :: 46 ms
118 2022-01-28 18:39:17.768 DEBUG [cps-application,e17da1571e518c59,e17da1571e518c59] 11128 --- [tp1901272535-29] o.onap.cps.aop.CpsLoggingAspectService : Execution time of : CpsAdminPersistenceServiceImpl.getAnchor() with argument[s] = [test42, bookstore] having result = Anchor(name=bookstore, dataspaceName=test42, schemaSetName=bookstore) :: 299 ms
120 2022-01-28 18:39:17.768 DEBUG [cps-application,e17da1571e518c59,e17da1571e518c59] 11128 --- [tp1901272535-29] o.onap.cps.aop.CpsLoggingAspectService : Execution time of : CpsAdminServiceImpl.getAnchor() with argument[s] = [test42, bookstore] having result = Anchor(name=bookstore, dataspaceName=test42, schemaSetName=bookstore) :: 305 ms
122 2022-01-28 18:39:17.843 DEBUG [cps-application,e17da1571e518c59,e17da1571e518c59] 11128 --- [tp1901272535-29] o.onap.cps.aop.CpsLoggingAspectService : Execution time of : AdminRestController.getAnchor() with argument[s] = [test42, bookstore] having result = <200 OK OK,class AnchorDetails {
124 dataspaceName: test42
125 schemaSetName: bookstore
129 Revert logging level of "logging.level.org.onap.cps" to 'INFO' again to prevent unnecessary logging and impacts on performance.
131 .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning
132 .. _cps_common_logging:
134 Logging & Diagnostics
135 =====================
140 CPS-Core logs are sent to `STDOUT` in order to leverage the Kubernetes logging architecture.
142 These logs are available using the following command:
146 kubectl logs <cps-core-pod>
148 The default configuration for CPS logs is the INFO level.
150 This architecture also makes all logs ready to be sent to an Elastic-search Log-stash and Kibana (ELK) stack or similar.
152 Enabling tracing for all executed sql statements is done by changing hibernate
155 Logger configuration is provided as a chart resource :
157 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
158 | cps-component-service-name | logback.xml location |
159 +================================+===============================================================================================================================================+
160 | cps-core | `logback-spring.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/resources/config/logback-spring.xml>`__ |
161 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
162 | cps-temporal | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`__ |
163 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
164 | ncmp-dmi-plugin | Not yet applicable to DMI-Plugin |
165 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
167 .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning
168 .. _cps_common_monitoring:
172 Once CPS-Core is deployed, information related to the running instance of the application is available
176 http://<cps-component-service-name>:8081/manage/info/
181 Cps-Core health status and state can be checked using the following endpoint.
182 This also includes both the liveliness state and readiness state.
186 http://<cps-component-service-name>:8081/manage/health/
191 Prometheus Metrics can be checked at the following endpoint
195 http://<cps-component-service-name>:8081/manage/prometheus
200 As part of the Kohn 3.1.0 release, CPS has added validation to the names of the following components:
205 - Cm-Handle identifiers
207 The following characters along with spaces are no longer valid for naming of these components.
211 !"#$%&'()*+,./\:;<=>?@[]^`{|}~