1pki-server-logging(5)  PKI Server Logging Configuration  pki-server-logging(5)
2
3
4

NAME

6       pki-server-logging - PKI Server Logging Configuration
7
8

LOCATION

10       /etc/pki/instance/logging.properties,         /etc/pki/instance/subsys‐
11       tem/CS.cfg
12
13

DESCRIPTION

15       PKI server logging can be configured using the following logging frame‐
16       works:
17
18
19              • java.util.logging                           ⟨https://docs.ora‐
20                cle.com/javase/8/docs/api/java/util/logging/package-sum‐
21                mary.html⟩
22
23              • Internal Logging
24
25
26
27   java.util.logging
28       Tomcat  uses  java.util.logging (JUL) as the default logging framework.
29       The  configuration  is  described  in   Tomcat   Logging   ⟨http://tom‐
30       cat.apache.org/tomcat-9.0-doc/logging.html⟩.
31
32
33       The default configuration is located at /usr/share/pki/server/conf/log‐
34       ging.properties.  During server deployment a link will  be  created  at
35       /etc/pki/instance/logging.properties.
36
37
38       By  default  only  log  messages  with  level WARNING or higher will be
39       logged on the console (i.e. systemd journal).
40
41
42              java.util.logging.ConsoleHandler.level = ALL
43              java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
44
45              java.util.logging.SimpleFormatter.format = %4$s: %5$s%6$s%n
46
47
48
49
50       The systemd journal can be viewed with the following command:
51
52
53              $ journalctl -u pki-tomcatd@<instance>.service
54
55
56
57       For more information see the following documents:
58
59
60              • java.util.logging.ConsoleHandler            ⟨https://docs.ora‐
61                cle.com/javase/8/docs/api/java/util/logging/ConsoleHan‐
62                dler.html⟩
63
64              • java.util.logging.Level                     ⟨https://docs.ora‐
65                cle.com/javase/8/docs/api/java/util/logging/Level.html⟩
66
67              • java.util.logging.SimpleFormatter           ⟨https://docs.ora‐
68                cle.com/javase/8/docs/api/java/util/logging/SimpleFormat‐
69                ter.html⟩
70
71              • java.util.Formatter                         ⟨https://docs.ora‐
72                cle.com/javase/8/docs/api/java/util/Formatter.html⟩
73
74
75
76   Internal Logging
77       Each PKI subsystem uses an internal  logging  framework  for  debugging
78       purposes.
79
80
81       The   logging  configuration  is  stored  in  /etc/pki/instance/subsys‐
82       tem/CS.cfg.
83
84
85              debug.level=10
86
87
88
89       The debug.level determines the amount of details  to  be  logged.   The
90       value  ranges from 0 (most details) to 10 (least details).  The default
91       value is 10.
92
93

CUSTOMIZATION

95   java.util.logging
96       To customize JUL configuration, replace the link with a copy of the de‐
97       fault configuration:
98
99
100              $ rm -f /etc/pki/<instance>/logging.properties
101              $ cp /usr/share/pki/server/conf/logging.properties /etc/pki/<instance>
102              $ chown pkiuser.pkiuser /etc/pki/<instance>/logging.properties
103
104
105
106       Then edit the file as needed.  For example, to troubleshoot issues with
107       PKI library add the following lines:
108
109
110              netscape.level = ALL
111              com.netscape.level = ALL
112              org.dogtagpki.level = ALL
113
114
115
116       To troubleshoot issues with RESTEasy add the following line:
117
118
119              org.jboss.resteasy.level = ALL
120
121
122
123       Then restart the server.
124
125
126   Internal Logging
127       To customize the internal logging configuration,  edit  the  CS.cfg  as
128       needed, then restart the server.
129
130

AUTHORS

132       Dogtag PKI Team <devel@lists.dogtagpki.org>.
133
134

SEE ALSO

136       pki-logging(5)
137
138

COPYRIGHT

140       Copyright  (c)  2016 Red Hat, Inc.  This is licensed under the GNU Gen‐
141       eral Public License, version 2 (GPLv2).  A  copy  of  this  license  is
142       available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
143
144
145
146PKI                            November 3, 2016          pki-server-logging(5)