Adds examples for Log4j 2's JSON format log template layout #29985
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
- Adds a full example for Log4j 2's JSON format log template layout file, MyLayout.json - Adds an instruction to remove dd.trace_id and dd_span.id from the template layout examples, if the log and trace correlation is not used.
📝 Documentation Team Review RequiredThis pull request requires approval from the @DataDog/documentation team before it can be merged. Please ensure your changes follow our documentation guidelines and wait for a team member to review and approve your changes. |
Preview links (active after the
|
|
@ptabasso2 FYI, I submitted a PR to add the JSON layout template to our official documentation. Thanks for your help! |
maycmlee
added
editorial review
|
Created DOCS-11251 for docs review |
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 does this PR do? What is the motivation?
The Java Log Collection docs are missing an example of a JSON layout template for the Log4j 2 appender. This template is necessary for Java apps to emit logs in JSON format, but the docs don't provide one. As someone who doesn't work with Java regularly, it took me quite a while to track down a working example. Judging from this Slack thread, I wasn’t the only one who ran into this.
https://dd.slack.com/archives/C4W013KEU/p1749835158457139
I have added the following to this doc page:
Please have a Java Log Collection PM or an APM Injection Platform PM review these changes.
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes