diff options
| author |   emaclee <lee.anjella.macabuhay@est.tech> | 2022-08-31 15:53:10 +0100 |
|---|---|---|
| committer |   Toine Siebelink <toine.siebelink@est.tech> | 2022-09-01 06:42:30 +0000 |
| commit | b176de24a873cbd6ff8df07c7947ed6ba7093af7 (patch) | |
| tree | a9da8f58744154b271b7945f9c55b7d7ef9157dd /docs/admin-guide.rst | |
| parent | 0a86b485cce8ad91b5a83895449e0a2ac7ffe267 (diff) | |
Fixing RTD warnings
Issue-ID: CPS-1237
Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech>
Change-Id: I0f09d6355d23451207d2d937fbda155b1407fb5a
Diffstat (limited to 'docs/admin-guide.rst')
| -rw-r--r-- | docs/admin-guide.rst | 43 |
1 files changed, 23 insertions, 20 deletions
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index 1bc7f4ff3..0d7c398e1 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -33,17 +33,17 @@ CPS Log pattern .. code-block:: java <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 ... - } + { + "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 @@ -63,6 +63,7 @@ Change logging level "effectiveLevel": "INFO" } + - Curl command 2. Change logging level of "logging.level.org.onap.cps" to "DEBUG" .. note:: @@ -92,6 +93,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 +137,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 +155,15 @@ 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.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 | + +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ .. 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: |