4.x: Docs: Add SE logging guide #10137
Conversation
oracle-contributor-agreement
bot
added
the
OCA Verified
barchetta
force-pushed
the
4.x-logging-docs
branch
from
68e093a to
2b1e0c8
Compare
tjquinno
left a comment
tjquinno
left a comment
There was a problem hiding this comment.
There are changes that should be made but I'll be out so I am not marking these as "requested" changes to avoid blocking progress on the PR!
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
barchetta
force-pushed
the
4.x-logging-docs
branch
from
cf49f4f to
2073467
Compare
| == 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: |
4 participants
Description
Documentation: Add SE logging guide.
See #9744