4.x: Docs: Add SE logging guide #10137
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oracle-contributor-agreement
bot
added
the
OCA Verified
tjquinno
reviewed
May 23, 2025
barchetta
force-pushed
the
4.x-logging-docs
branch
from
68e093a to
2b1e0c8
Compare
tjquinno
reviewed
May 30, 2025
barchetta
force-pushed
the
4.x-logging-docs
branch
from
2b1e0c8 to
c0d0f8f
Compare
barchetta
force-pushed
the
4.x-logging-docs
branch
from
c0d0f8f to
cf49f4f
Compare
romain-grecourt
previously approved these changes
Sep 11, 2025
barchetta
force-pushed
the
4.x-logging-docs
branch
from
cf49f4f to
2073467
Compare
romain-grecourt
approved these changes
Oct 15, 2025
tjquinno
approved these changes
Oct 15, 2025
ljnelson
reviewed
Oct 23, 2025
| == Helidon Logging | ||
|
|
||
| Helidon modules use the Java Platform Logging API (`System.Logger`) for logging. Therefore, | ||
| Helidon applications will use Java Util Logging (JUL) as the default log framework. |
There was a problem hiding this comment.
I don't know if it matters but Java calls the java.logging module, which houses the java.util.logging package, the Java Logging API.
| == Customizing Logging with Java Util Logging | ||
|
|
||
| Since by default Helidon uses the Java Util Logging framework, you will see a | ||
| `logging.properties` file in most Helidon examples. It will be similar to this: |
There was a problem hiding this comment.
Nit: the usage of logging.properties doesn't follow from the fact that the Java Logging API is used. Obviously people are somewhat familiar with the default logging.properties used by the JVM.
|
|
||
| `HelidonConsoleHandler` is similar to the JUL `ConsoleHandler` with these additional capabilities: | ||
|
|
||
| 1. Defaults the Handler log level to ALL so level filtering is performed only by the Logger |
There was a problem hiding this comment.
Handler -> Handler? ALL -> ALL? Logger -> Logger? Or just "logger"? Not sure what the convention you want is
| `HelidonConsoleHandler` is similar to the JUL `ConsoleHandler` with these additional capabilities: | ||
|
|
||
| 1. Defaults the Handler log level to ALL so level filtering is performed only by the Logger | ||
| 2. Uses `HelidonFormatter` which is compatible with JUL `SimpleFormatter` and adds support for MDC tags and the `!thread!` keyword |
There was a problem hiding this comment.
Is this the first reference to MDC? If so maybe link to the section somehow
|
|
||
| == log4j and slf4j support | ||
|
|
||
| If you wish to use another log framework, such has log4j or slf4j, and you wish to consolidate Helidon logging |
There was a problem hiding this comment.
"consolidate Helidon logging with" -> "route Helidon logs through"?
|
|
||
| === log4j | ||
|
|
||
| To use `log4j` with your Helidon application add the following dependencies: |
|
|
||
| === slf4j | ||
|
|
||
| To use `slf4j` with your Helidon application add the following dependencies: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Documentation: Add SE logging guide.
See #9744