[reorg fix] Clarify auto multi-line before/after example in Overview - #38844
Merged
Conversation
The Overview example rendered identically before and after aggregation, so the effect of the feature was not visible, and the surrounding text stated the stack trace was aggregated into "a single log" when the example actually produces two. - Annotate each line in the "before" block to show the Agent emits one log per line when detection is disabled. - Bracket the aggregated lines in the "after" block and label the two resulting logs, so the grouping is legible in rendered output. - Explain that only lines beginning with a datetime start a new log, which is why the trailing INFO line remains its own log. - Use `text` fences and add blank lines around them, matching the convention used in the custom samples section. Co-Authored-By: Claude <noreply@anthropic.com>
jhgilbert
added
WORK IN PROGRESS
1 task
This comment has been minimized.
This comment has been minimized.
Updated the formatting of log examples for clarity.
Updated examples to illustrate the effect of Auto multi-line detection on log formatting.
evazorro
reviewed
Aug 6, 2026
| ``` | ||
| With Auto multi-line detection enabled, the stack trace is aggregated into a single log: | ||
|
|
||
| For example, an application writes the following five lines. Without Auto multi-line detection, the Agent sends each line as its own log, splitting the exception away from the message that introduced it: |
Contributor
There was a problem hiding this comment.
@rhy988 Is there a reason Auto is capitalized in this doc? It makes it look like a proper noun or product name, and I'm not sure if that's intentional
Contributor
There was a problem hiding this comment.
Not intentional — good catch. There were a few more instances too, fixed them all.
Corrected a minor grammatical error in the explanation of auto multi-line detection.
Corrected capitalization and formatting inconsistencies in the documentation regarding auto multi-line detection.
evazorro
requested changes
Aug 6, 2026
Co-authored-by: Eva Parish <eva.parish@datadoghq.com>
evazorro
approved these changes
Aug 7, 2026
Contributor
Preview links (active after the
|
Updated example log output to reflect auto multi-line detection.
Clarified how auto multi-line detection aggregates logs.
Clarified the default behavior of auto multi-line detection regarding log entries.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
🤖 Auto-generated fix for #38816.
@rhy988 — the docs repo reorg created merge conflicts in your PR #38816. This is an auto-generated replacement with the file paths fixed; please use it instead of the original.
This PR replays the commits from #38816 with file paths translated to the post-reorg
hugo/layout. The original commits are preserved — same messages and authorship.The original PR (#38816) will be closed in favor of this one.
Next steps:
WORK IN PROGRESSlabel from this PR.Original PR description:
Follow-up to #37889, addressing @Brian-Floersch's review feedback.
What does this PR do? What is the motivation?
Two fixes to the example in the Overview:
INFOline begins with a datetime, so it starts its own log.Merge readiness
For Datadog employees:
<name>/<description>convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR./reviewto run an automated check that catches common issues before a Documentation team member reviews your PR.AI assistance
Used Claude Code to revise the example and draft this description.
Additional notes
Opened as a new PR since #37889 is already merged. Happy to swap the annotated text blocks for a Logs Explorer screenshot if that reads better.