docs/sections/logging.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 2020 NOKIA
   4
   5 Logging
   6 =======
   7
   8 Certification Service API
   9 --------------------------
  10
  11
  12 Certification Service logs are available in the Docker container
  13
  14     docker exec -it aaf-certservice-api bash
  15
  16 Path to logs:
  17
  18     /var/log/onap/aaf/certservice
  19
  20 Available log files:
  21     * audit.log
  22     * debug.log
  23     * error.log
  24
  25
  26 Certification Service Client
  27 ----------------------------
  28 To see logs use :
  29
  30 - Docker:
  31
  32 .. code-block:: bash
  33
  34    docker logs cert-service-client
  35
  36 - Kubernetes:
  37
  38 .. code-block:: bash
  39
  40    kubectl logs <pod-name> cert-service-client
  41
  42
  43 Logs are stored inside container log path:
  44
  45   /var/logs
  46
  47 Client application exits with following exit codes:
  48
  49
  50 +-------+------------------------------------------------+
  51 | Code  | Information                                    |
  52 +=======+================================================+
  53 | 0     | Success                                        |
  54 +-------+------------------------------------------------+
  55 | 1     | Invalid client configuration                   |
  56 +-------+------------------------------------------------+
  57 | 2     | Invalid CSR configuration                      |
  58 +-------+------------------------------------------------+
  59 | 3     | Fail in key pair generation                    |
  60 +-------+------------------------------------------------+
  61 | 4     | Fail in CSR generation                         |
  62 +-------+------------------------------------------------+
  63 | 5     | CertService HTTP unsuccessful response         |
  64 +-------+------------------------------------------------+
  65 | 6     | Internal HTTP Client connection problem        |
  66 +-------+------------------------------------------------+
  67 | 7     | Fail in PKCS12 conversion                      |
  68 +-------+------------------------------------------------+
  69 | 8     | Fail in Private Key to PEM Encoding            |
  70 +-------+------------------------------------------------+