X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fadmin-guide.rst;h=eeac013773a550d543d66401e194483a0aeefdd8;hb=5ced56253a01fadf5376bc5e1202a7ac7e136794;hp=135040faaf15b9d961ec75f9f36b5bd3470a2564;hpb=a1129b696f3197fc7d8a3b63bcd84b5b2dd8874e;p=cps.git
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst
index 135040faa..eeac01377 100644
--- a/docs/admin-guide.rst
+++ b/docs/admin-guide.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2021 Nordix Foundation
+.. Copyright (C) 2021-2022 Nordix Foundation
.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
.. _adminGuide:
@@ -33,17 +33,16 @@ CPS Log pattern
.. code-block:: java
- {
- "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 ...
- }
+ {
+ "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
+ }
Change logging level
@@ -63,6 +62,7 @@ Change logging level
"effectiveLevel": "INFO"
}
+
- Curl command 2. Change logging level of "logging.level.org.onap.cps" to "DEBUG"
.. note::
@@ -92,6 +92,7 @@ Change logging level
"effectiveLevel": "DEBUG"
}
+
Location of log files
---------------------
By default, Spring Boot will only log to the console and will not write log files.
@@ -135,6 +136,7 @@ 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:
@@ -152,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.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:
@@ -191,3 +193,19 @@ Prometheus Metrics can be checked at the following endpoint
.. code::
http://:8081/manage/prometheus
+
+Naming Validation
+-----------------
+
+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
+ - Anchor names
+ - Cm-Handle identifiers
+
+The following characters along with spaces are no longer valid for naming of these components.
+
+.. code::
+
+ !"#$%&'()*+,./\:;<=>?@[]^`{|}~