chore(logging): correct wide-event comments, document the sink split - #1016
Open
alexluong wants to merge 2 commits into
Open
chore(logging): correct wide-event comments, document the sink split#1016alexluong wants to merge 2 commits into
alexluong wants to merge 2 commits into
Conversation
The hot-path wide events (delivery.attempted, event.received) are Info, but several comments around them called them audit events — leftover wording from the multi-line audit calls they replaced. Nothing routes them to the OTel logs sink, so the comments described behavior that doesn't exist. Say where each sink's line belongs once, on logging.Logger, and drop the history and re-explanation from the call sites. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The struct doc's job is the type — two sinks, what each is. Which method a call site should pick is doc for Audit, and doesn't need a list of call sites that goes stale. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
delivery.attemptedandevent.receivedare emitted withInfo, but the comments around them called them audit events. That wording is left over from the multi-lineAudit()calls they replaced in #913 — the same commit introduced both the wide events and the Audit→OTel split, and deliberately put per-unit-of-work lines on the operator sink. Nothing routes them to the OTel logs SDK, so the comments described behavior that doesn't exist.logging.Logger— say which sink a line belongs on, once, next to the split it describesmessagehandler.go,eventhandler.go— drop the "replaces X and Y" history and the re-explanation of the wide-event pattern; keep only what the code can't say (whyretryOutcomeexists, why swallowing an attempt error is safe)Comments only; no behavior change.
🤖 Generated with Claude Code