.nh
.TH pki-logging 5 "November 3, 2016" PKI "PKI Common Logging Configuration"
.SH NAME
.PP
pki-logging - PKI Common Logging Configuration

.SH LOCATION
.PP
/usr/share/pki/etc/logging.properties, /etc/pki/logging.properties

.SH DESCRIPTION
.PP
PKI clients and tools use java.util.logging
\[la]https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html\[ra]
(JUL) as the logging framework.

.PP
The default logging configuration is located at /usr/share/pki/etc/logging.properties.

.PP
By default only log messages with level WARNING or higher will be logged on the console.

.PP
.RS

.nf
java.util.logging.ConsoleHandler.level = ALL
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

java.util.logging.SimpleFormatter.format = %4$s: %5$s%6$s%n

.level = WARNING
.handlers = java.util.logging.ConsoleHandler

.fi
.RE

.PP
For more information see the following documents:

.RS
.IP \(bu 2
java.util.logging.ConsoleHandler
\[la]https://docs.oracle.com/javase/8/docs/api/java/util/logging/ConsoleHandler.html\[ra]
.IP \(bu 2
java.util.logging.Level
\[la]https://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html\[ra]
.IP \(bu 2
java.util.logging.SimpleFormatter
\[la]https://docs.oracle.com/javase/8/docs/api/java/util/logging/SimpleFormatter.html\[ra]
.IP \(bu 2
java.util.Formatter
\[la]https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html\[ra]

.RE

.SH CUSTOMIZATION
.PP
To customize the logging configuration, copy the default logging configuration into a new location:

.PP
.RS

.nf
$ cp /usr/share/pki/etc/logging.properties /etc/pki/logging.properties

.fi
.RE

.PP
Then edit the file as needed.
For example, to troubleshoot issues with PKI library add the following lines:

.PP
.RS

.nf
netscape.level = ALL
com.netscape.level = ALL
org.dogtagpki.level = ALL

.fi
.RE

.PP
To troubleshoot issues with RESTEasy add the following line:

.PP
.RS

.nf
org.jboss.resteasy.level = ALL

.fi
.RE

.PP
Then specify the location of the custom logging configuration in the following parameter in /etc/pki/pki.conf:

.PP
.RS

.nf
PKI_LOGGING_CONFIG=/etc/pki/logging.properties

.fi
.RE

.PP
Then restart the application.

.SH SEE ALSO
.PP
\fBpki-server-logging(5)\fP

.SH AUTHORS
.PP
Dogtag PKI Team <devel@lists.dogtagpki.org>\&.

.SH COPYRIGHT
.PP
Copyright (c) 2016 Red Hat, Inc.
This is licensed under the GNU General Public License, version 2 (GPLv2).
A copy of this license is available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.