[#5389] feat(logging): add org.apache.logging.log4j:log4j-layout-template-json to support server log in json format #5388
Conversation
This file contains 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
…n format log output
|
Hi @puchengy thanks a lot for your contribution. Can you please create a related issue about this, also change the PR title and description to map to the related issue? Thanks a lot. |
puchengy
changed the title
|
@jerryshao for sure, done. |
|
LGTM, @puchengy , could you provide an json configuration example in the PR description, then the other user could reffer to it? |
|
Yes, we should, @puchengy can you please update the "LICENSE.bin" for your newly added dependency, thanks! |
|
@FANNG1 @yuqi1129 @jerryshao Thanks all. Added a json configuration in the test plan as an example. Also added dep to licensen.bin, the name of the library is obtained from https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-layout-template-json. PTAL, thanks |
jerryshao
pushed a commit
to jerryshao/gravitino
that referenced
this pull request
Nov 1, 2024
…t-template-json to support server log in json format (apache#5388) ### What changes were proposed in this pull request? Add org.apache.logging.log4j:log4j-layout-template-json to support server log in json format. ### Why are the changes needed? There are use cases required server logs to be viewed from logsearch tools such as Kibana. These use cases recommends log format to be json. Based on https://logging.apache.org/log4j/2.x/manual/json-template-layout.html, `log4j-layout-template-json` is needed to enable json layout for log4j. Fix: apache#5389 ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Tested locally with modified lo4j property file. ``` appender.rolling.layout.type = JsonTemplateLayout appender.rolling.layout.eventTemplate = {"instant":{"$resolver":"timestamp","pattern":{"format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","timeZone":"UTC"}},"level":{"$resolver":"level","field":"name"},"thread":{"$resolver":"thread","field":"name"},"message":{"$resolver":"message","stringified":true},"exception":{"$resolver":"exception","field":"stackTrace","stackTrace":{"stringified":true}}} ``` For better usability, json can be passed in via a individual file using [eventTemplateUri](https://logging.apache.org/log4j/2.x/manual/json-template-layout.html#plugin-attr-eventTemplateUri) instead.
mplmoknijb
pushed a commit
to mplmoknijb/gravitino
that referenced
this pull request
Nov 6, 2024
…t-template-json to support server log in json format (apache#5388) ### What changes were proposed in this pull request? Add org.apache.logging.log4j:log4j-layout-template-json to support server log in json format. ### Why are the changes needed? There are use cases required server logs to be viewed from logsearch tools such as Kibana. These use cases recommends log format to be json. Based on https://logging.apache.org/log4j/2.x/manual/json-template-layout.html, `log4j-layout-template-json` is needed to enable json layout for log4j. Fix: apache#5389 ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Tested locally with modified lo4j property file. ``` appender.rolling.layout.type = JsonTemplateLayout appender.rolling.layout.eventTemplate = {"instant":{"$resolver":"timestamp","pattern":{"format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","timeZone":"UTC"}},"level":{"$resolver":"level","field":"name"},"thread":{"$resolver":"thread","field":"name"},"message":{"$resolver":"message","stringified":true},"exception":{"$resolver":"exception","field":"stackTrace","stackTrace":{"stringified":true}}} ``` For better usability, json can be passed in via a individual file using [eventTemplateUri](https://logging.apache.org/log4j/2.x/manual/json-template-layout.html#plugin-attr-eventTemplateUri) instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changes were proposed in this pull request?
Add org.apache.logging.log4j:log4j-layout-template-json to support server log in json format.
Why are the changes needed?
There are use cases required server logs to be viewed from logsearch tools such as Kibana. These use cases recommends log format to be json.
Based on https://logging.apache.org/log4j/2.x/manual/json-template-layout.html,
log4j-layout-template-jsonis needed to enable json layout for log4j.Fix: #5389
Does this PR introduce any user-facing change?
No.
How was this patch tested?
Tested locally with modified lo4j property file.
For better usability, json can be passed in via a individual file using eventTemplateUri instead.