[#5389] feat(logging): add org.apache.logging.log4j:log4j-layout-template-json to support server log in json format #5407
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
…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.
FANNG1
approved these changes
Nov 1, 2024
danhuawang
pushed a commit
to danhuawang/gravitino
that referenced
this pull request
Nov 4, 2024
…t-template-json to support server log in json format (apache#5407) ### 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. Co-authored-by: Pucheng Yang <[email protected]>
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.