Skip to content

Conversation

@adinauer
Copy link
Member

Added section on client reports for discarded log messages.

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Added section on client reports for discarded log messages.
@vercel
Copy link

vercel bot commented Nov 18, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
develop-docs Ready Ready Preview Comment Nov 18, 2025 10:55am
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
sentry-docs Ignored Ignored Preview Nov 18, 2025 10:55am

Comment on lines +690 to +693

## Client Reports

SDKs must report count (`log_item`) and size in bytes (`log_byte`) of discarded log messages. An approximation of log size is sufficient (e.g. by counting as if serialized).
Copy link

Choose a reason for hiding this comment

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

Bug: The documentation incorrectly mandates reporting log_byte for discarded log messages, which is not a valid data category in the client reports protocol and contradicts its single quantity metric design.
Severity: CRITICAL | Confidence: 0.98

🔍 Detailed Analysis

The documentation instructs SDKs to report log_byte for discarded log messages, but log_byte is not a defined data category in the client reports protocol. The protocol only supports a single quantity metric per category, not separate count and size fields. SDKs following this would either send reports with an undefined log_byte category, causing backend validation failures, or only report one metric, contradicting the documented requirement. This creates contradictory and unimplementable requirements for SDKs.

💡 Suggested Fix

Remove the requirement to report log_byte. Clarify that the quantity field for log_item should represent the count of discarded log messages, as log_byte is not a supported category for size reporting.

🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: develop-docs/sdk/telemetry/logs.mdx#L690-L693

Potential issue: The documentation instructs SDKs to report `log_byte` for discarded log
messages, but `log_byte` is not a defined data category in the client reports protocol.
The protocol only supports a single `quantity` metric per category, not separate count
and size fields. SDKs following this would either send reports with an undefined
`log_byte` category, causing backend validation failures, or only report one metric,
contradicting the documented requirement. This creates contradictory and unimplementable
requirements for SDKs.

Did we get this right? 👍 / 👎 to inform future reviews.

Reference_id: 2763240

@adinauer adinauer enabled auto-merge (squash) November 18, 2025 10:54
@adinauer adinauer merged commit 5819cdd into master Nov 18, 2025
13 checks passed
@adinauer adinauer deleted the adinauer-patch-2 branch November 18, 2025 10:56
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.

3 participants