CPS Admin Guide

Logging Configuration

Note

Default logging level of “logging.level.org.onap.cps” is set to “INFO”.

logging:
 level:
     org:
         springframework: INFO
         onap:
             cps: INFO

CPS Log pattern

<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 ...
        }
</pattern>

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)

curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
--header 'Content-Type: application/json; charset=utf-8'

Response body : HTTP Status 200

{
    "configuredLevel": "INFO",
    "effectiveLevel": "INFO"
}
  • Curl command 2. Change logging level of “logging.level.org.onap.cps” to “DEBUG”

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.

curl --location --request POST 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
                "configuredLevel": "DEBUG"
            }'

Response body : HTTP Status 204
  • Curl command 3. Verify if log level of “logging.level.org.onap.cps” is changed from ‘INFO’ to ‘DEBUG’

curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
--header 'Content-Type: application/json; charset=utf-8'

Response body : HTTP Status 200

{
"configuredLevel": "DEBUG",
"effectiveLevel": "DEBUG"
}

Location of log files

By default, Spring Boot will only log to the console and will not write log files.

CPS service console

Measure Execution Time of CPS Service

Note

Make sure effective log level of “logging.level.org.onap.cps” is ‘DEBUG’. This can be verified by executing curl command 3.

Execute CPS service that you want to calculate total elapsed time and log as shown below

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

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

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

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

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 {
 name: bookstore
 dataspaceName: test42
 schemaSetName: bookstore
},[]> :: 419 ms

Warning

Revert logging level of “logging.level.org.onap.cps” to ‘INFO’ again to prevent unnecessary logging and impacts on performance.

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:

kubectl logs <cps-core-pod>

The default configuration for CPS logs is the INFO level.

This architecture also makes all logs ready to be sent to an Elastic-search Log-stash and Kibana (ELK) stack or similar.

Enabling tracing for all executed sql statements is done by changing hibernate 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

Monitoring

Once CPS-Core is deployed, information related to the running instance of the application is available

http://<cps-component-service-name>:8081/manage/info/

Health

Cps-Core health status and state can be checked using the following endpoint. This also includes both the liveliness state and readiness state.

http://<cps-component-service-name>:8081/manage/health/

Metrics

Prometheus Metrics can be checked at the following endpoint

http://<cps-component-service-name>:8081/manage/prometheus

Naming Validation

As part of the Jakarta 3.1.0 release, CPS has added validation to the names of the following components:

  • Dataspace names

  • Schema Set names

  • Anchor names

  • Cm-Handle identifiers

The following characters along with spaces are no longer valid for naming of these components.

!"#$%&'()*+,./\:;<=>?@[]^`{|}~