Set Python and Ubuntu versions in .readthedocs.yaml
[oom/platform/cert-service.git] / 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-2021 NOKIA
4
5
6 Logging
7 =======
8
9 CertService API
10 ---------------
11 To see CertService console logs use:
12
13 - Docker:
14
15 .. code-block:: bash
16
17     docker logs <cert-service-container-name>
18
19     e.g.
20     docker logs oomcert-service
21
22 - Kubernetes:
23
24 .. code-block:: bash
25
26     kubectl -n onap logs <cert-service-pod-name>
27
28     e.g.
29     kubectl -n onap logs $(kubectl -n onap get pods | grep cert-service | awk '{print $1}')
30
31 Console logs contains logs for logging levels from **DEBUG** to **ERROR**.
32
33 CertService logs for different logging levels are available in the container:
34
35 - Docker:
36
37 .. code-block:: bash
38
39     docker exec -it <cert-service-container-name> bash
40
41     e.g.
42     docker exec -it oomcert-service bash
43
44 - Kubernetes:
45
46 .. code-block:: bash
47
48     kubectl -n onap exec -it <cert-service-pod-name> bash
49
50     e.g.
51     kubectl -n onap exec -it $(kubectl -n onap get pods | grep cert-service | awk '{print $1}') bash
52
53 Path to logs:
54
55     /var/log/onap/oom/certservice
56
57 Available log files:
58
59     - audit.log - contains logs for **INFO** logging level
60     - debug.log - contains logs for logging levels from **DEBUG** to **ERROR**
61     - error.log - contains logs for **ERROR** logging level
62
63 User cannot change logging levels.
64
65 CMPv2 certificate provider
66 --------------------------
67 To see CMPv2 certificate provider console logs use :
68
69 .. code-block:: bash
70
71     kubectl -n onap logs <cmpv2-certificate-provider-pod-name> provider
72
73     e.g.
74     kubectl -n onap logs $(kubectl -n onap get pods | grep cmpv2-cert-provider | awk '{print $1}') provider