pki-logging(5)

💖 NAME 💖

pki-logging — the PKI Common Logging Configuration, bestie! This is the pki-logging(5) manual page, and it's literally your guide to how the PKI fam sets up logging. Periodt. ✨

📍 LOCATION 📍

The files live here:

• /usr/share/pki/etc/logging.properties
• /etc/pki/logging.properties

✨ DESCRIPTION ✨

Okay so PKI clients and tools use java.util.logging — JUL for short — as the logging framework. The package summary is right here: https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html.

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

By default, only log messages with level WARNING or higher will be logged on the console. No cap. 💅

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

For more information, see these documents — go off, honestly:

• java.util.logging.ConsoleHandler — https://docs.oracle.com/javase/8/docs/api/java/util/logging/ConsoleHandler.html
• java.util.logging.Level — https://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html
• java.util.logging.SimpleFormatter — https://docs.oracle.com/javase/8/docs/api/java/util/logging/SimpleFormatter.html
• java.util.Formatter — https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html

🎀 CUSTOMIZATION 🎀

To customize the logging configuration, copy the default logging configuration into a new location:

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

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

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

To troubleshoot issues with RESTEasy, add this line:

org.jboss.resteasy.level = ALL

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

PKI_LOGGING_CONFIG=/etc/pki/logging.properties

Then restart the application. Slay. 🔥

👀 SEE ALSO 👀

• pki-server-logging(5)

🫶 AUTHORS 🫶

Shoutout to the authors: Dogtag PKI Team lt;devel@lists.dogtagpki.orggt>. 💖

©️ COPYRIGHT ©️

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.

---

This page is from the PKI collection and is dated November 3, 2016 — mwah, bestie 💋🦋