Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#5389] feat(logging): add org.apache.logging.log4j:log4j-layout-template-json to support server log in json format #5388

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

puchengy
Copy link

@puchengy puchengy commented Oct 31, 2024

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: #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 instead.

@jerryshao
Copy link
Contributor

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 puchengy changed the title Add org.apache.logging.log4j:log4j-layout-template-json to enable json format log output [#5389] feat(logging): add org.apache.logging.log4j:log4j-layout-template-json to support server log in json format Oct 31, 2024
@puchengy
Copy link
Author

@jerryshao for sure, done.

@FANNG1
Copy link
Contributor

FANNG1 commented Oct 31, 2024

LGTM, @puchengy , could you provide an json configuration example in the PR description, then the other user could reffer to it?

@yuqi1129
Copy link
Contributor

@FANNG1 @puchengy
Do we need to add the newly added dependency to the file License.bin?

@jerryshao
Copy link
Contributor

Yes, we should, @puchengy can you please update the "LICENSE.bin" for your newly added dependency, thanks!

Copy link
Contributor

@jerryshao jerryshao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @puchengy for your contribution.

@puchengy
Copy link
Author

puchengy commented Oct 31, 2024

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Enable server log in json format
4 participants