diff options
| author |   lukegleeson <luke.gleeson@est.tech> | 2021-09-28 12:24:07 +0100 |
|---|---|---|
| committer | Luke Gleeson <luke.gleeson@est.tech> | 2021-10-11 09:58:34 +0000 |
| commit | a0f97c19e9efe1f2e8107d84408d8f9ecf02e6ac (patch) | |
| tree | cb3b2cc03338d5cab95562ecca89f3dd7aa95e06 | |
| parent | 66b598a4243bb702059902af2903d1c3da01d5fa (diff) | |
Update Admin Guide
Update Admin Guide to add Logging, Health and Monitoring information as
part of finalized documentation
Issue-ID: CPS-626
Change-Id: Ic573935f86ed4c5757509805c850e43d731a39c9
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
Signed-off-by: lukegleeson <luke.gleeson@est.tech>
| -rw-r--r-- | docs/admin-guide.rst | 58 |
1 files changed, 56 insertions, 2 deletions
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index 8e917e1f51..fab8d54a4c 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -9,10 +9,64 @@ CPS Admin Guide ############### -.. warning:: draft - .. toctree:: :maxdepth: 1 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: + +.. code:: bash + + 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 <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 | + +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +Monitoring +========== +Once CPS-Core is deployed, information related to the running instance of the application is available + +.. code:: + + 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. + +.. code:: + + http://<cps-component-service-name>:8081/manage/health/ + +Metrics +------- + +Prometheus Metrics can be checked at the following endpoint + +.. code:: + + http://<cps-component-service-name>:8081/manage/prometheus
\ No newline at end of file |