docs/admin-guide.rst

   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 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _adminGuide:
   7
   8
   9 CPS Admin Guide
  10 ###############
  11
  12 .. toctree::
  13    :maxdepth: 1
  14
  15 .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning
  16 .. _cps_common_logging:
  17
  18 Logging & Diagnostics
  19 =====================
  20
  21 General Guidelines
  22 ------------------
  23 CPS-Core logs are sent to `STDOUT` in order to leverage the Kubernetes logging architecture.
  24
  25 These logs are available using the following command:
  26
  27 .. code:: bash
  28
  29     kubectl logs <cps-core-pod>
  30
  31 The default configuration for CPS logs is the INFO level.
  32
  33 This architecture also makes all logs ready to be sent to an Elastic-search Log-stash and Kibana (ELK) stack or similar.
  34
  35 Enabling tracing for all executed sql statements is done by changing hibernate
  36 loggers log level
  37
  38 Logger configuration is provided as a chart resource :
  39
  40     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
  41     | cps-component-service-name     | logback.xml location                                                                                                            |
  42     +================================+=================================================================================================================================+
  43     | cps-core                       | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/resources/config/logback.xml>`_        |
  44     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
  45     | cps-temporal                   | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`_    |
  46     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
  47     | ncmp-dmi-plugin                | Not yet applicable to DMI-Plugin                                                                                                |
  48     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
  49
  50 .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning
  51 .. _cps_common_monitoring:
  52
  53 Monitoring
  54 ==========
  55 Once CPS-Core is deployed, information related to the running instance of the application is available
  56
  57 .. code::
  58
  59     http://<cps-component-service-name>:8081/manage/info/
  60
  61 Health
  62 ------
  63
  64 Cps-Core health status and state can be checked using the following endpoint.
  65 This also includes both the liveliness state and readiness state.
  66
  67 .. code::
  68
  69     http://<cps-component-service-name>:8081/manage/health/
  70
  71 Metrics
  72 -------
  73
  74 Prometheus Metrics can be checked at the following endpoint
  75
  76 .. code::
  77
  78     http://<cps-component-service-name>:8081/manage/prometheus