Skip to content

Mention client reports in Logs dev docs #15541

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 18, 2025
Merged

Mention client reports in Logs dev docs #15541

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions develop-docs/sdk/telemetry/logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,3 +687,7 @@ Example:
: **String, optional**. The time the log was created in Unix nanoseconds. If not set, the SDK should set this to the current time.

</Expandable>

## 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).
Comment on lines +690 to +693
Copy link

@sentry sentry bot Nov 18, 2025

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

Loading