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 Logging & Diagnostics
  16 =====================
  17
  18 General Guidelines
  19 ------------------
  20 CPS-Core logs are sent to `STDOUT` in order to leverage the Kubernetes logging architecture.
  21
  22 These logs are available using the following command:
  23
  24 .. code:: bash
  25
  26     kubectl logs <cps-core-pod>
  27
  28 The default configuration for CPS logs is the INFO level.
  29
  30 This architecture also makes all logs ready to be sent to an Elastic-search Log-stash and Kibana (ELK) stack or similar.
  31
  32 Enabling tracing for all executed sql statements is done by changing hibernate
  33 loggers log level
  34
  35 Logger configuration is provided as a chart resource :
  36
  37     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
  38     | cps-component-service-name     | logback.xml location                                                                                                            |
  39     +================================+=================================================================================================================================+
  40     | cps-core                       | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/resources/config/logback.xml>`_        |
  41     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
  42     | cps-temporal                   | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`_    |
  43     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
  44     | ncmp-dmi-plugin                | Not yet applicable to DMI-Plugin                                                                                                |
  45     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
  46
  47 Monitoring
  48 ==========
  49 Once CPS-Core is deployed, information related to the running instance of the application is available
  50
  51 .. code::
  52
  53     http://<cps-component-service-name>:8081/manage/info/
  54
  55 Health
  56 ------
  57
  58 Cps-Core health status and state can be checked using the following endpoint.
  59 This also includes both the liveliness state and readiness state.
  60
  61 .. code::
  62
  63     http://<cps-component-service-name>:8081/manage/health/
  64
  65 Metrics
  66 -------
  67
  68 Prometheus Metrics can be checked at the following endpoint
  69
  70 .. code::
  71
  72     http://<cps-component-service-name>:8081/manage/prometheus