Skip to content

ref(develop): Clarify client report quantity for logs, metrics and spans - #19854

Merged
Lms24 merged 3 commits into
masterfrom
lms/ref-develop-client-report-counts
Oct 9, 2026
Merged

Lms24 merged 3 commits into
masterfrom
lms/ref-develop-client-report-counts

Conversation

@Lms24

@Lms24 Lms24 commented Oct 8, 2026 •

Copy link
Copy Markdown
Member

Clarifies

  • that logs, metrics and span client reports must set the number of items as the quantitiy
  • which client reports, SDKs must send at a minimum for each of the three, since that was scattered around a bit beforehand.

@vercel

vercel Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 9, 2026 9:52am UTC
1 Skipped Deployment
Project Deployment Actions Updated
sentry-docs Ignored Ignored Preview Oct 9, 2026 9:52am UTC

Request Review

@github-actions github-actions Bot added sdk-develop-docs PRs touching develop-docs/sdk Priority: Needs Triage The PR description is missing valid priority information labels Oct 8, 2026
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

Please update the IS YOUR CHANGE URGENT? section of the PR description:

  • Select exactly one option.
  • If you selected an urgent or other deadline, provide the date as YYYY-MM-DD.

This information helps the Docs team prioritize your review.

@cursor

cursor Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

The change adds quantity rules to four spec pages. The plan checks client errors and the TypeError share on the MDX catch-all route. An issue escalates when those errors rise. Page wording is not in telemetry.

Rollout complete

Services: develop-docs.

Plan

What changed

Four SDK telemetry spec pages now state client-report quantity for discarded logs, metrics, and spans. The quantity is the number of contained items, not one per envelope. The pages are /sdk/telemetry/client-reports/, /sdk/telemetry/logs/, /sdk/telemetry/metrics/, and /sdk/telemetry/spans/. This change is live after a production deploy of develop-docs. Shared app code did not change, so sentry-docs does not ship it.

Risk

Bad MDX can fail the static build or break those four pages at runtime. A renderer error on the catch-all route can also affect sibling documentation pages. If the wording is wrong, SDK authors may record quantity 1 for batched envelopes.

Intended effect

This is a documentation edit. Telemetry cannot show the new spec text. intended_effect stays unknown from errors and traces. absent means the four pages still omit the item-count quantity rules. The executor cannot confirm the wording from Sentry.

Regression watch

A failed MDX render would show as client errors on the catch-all route that serves these pages. Pageload traces for the four routes returned no rows, so this watch uses error counts. Request volume is missing. Treat a sustained rise above the band as detected. Short windows can vary around the 7d mean.

Signal Baseline Rule Window Source
Error events on transaction /:path*? 26 events in 24h. 193 events in 7d. Daily equivalent about 28. Band 26-28 events per 24h. Hold in band. detected if the next 24h count rises above 28 and stays there. 2026-10-07T14:17Z to 2026-10-08T14:17Z. 7d: 2026-10-01T14:17Z to 2026-10-08T14:17Z. Sentry errors, sentry/develop-docs, environment:production transaction:"/:path*?"
TypeError share on /:path*? 13 TypeError, 7 Error, 3 UnhandledRejection, 2 Event, 1 SecurityError. TypeError share 13/26 = 0.50. Hold near 0.50. detected if TypeError count rises above 13 in an equal 24h window and total errors also rise. 2026-10-07T14:17Z to 2026-10-08T14:17Z Same project and filter. Group by error.type.

If the error count rises, inspect events on /:path*? for MDX or SpecSection render failures on the four spec paths.

Not observable

Published HTML of the four pages is not in Sentry, so the new wording has no telemetry signal. Pageload and navigation traces for those routes and for transaction:*sdk* returned no rows in production over 7d. Request volume is therefore missing, and error rate cannot be computed.

Get Slack DMs about this change: cursor.com/automations/rollouts

Comment thread develop-docs/sdk/telemetry/client-reports.mdx Outdated
@Lms24
Lms24 enabled auto-merge (squash) October 9, 2026 09:49
@Lms24
Lms24 merged commit ca4e0ca into master Oct 9, 2026
26 checks passed
@Lms24
Lms24 deleted the lms/ref-develop-client-report-counts branch October 9, 2026 09:52
0xadam-brown added a commit to getsentry/sentry-java that referenced this pull request Oct 15, 2026
Dropped span envelope items were recorded with a quantity of 1. Hybrid SDKs like sentry-dart send batched span items through sentry-java when span streaming is enabled, so read the count from the item_count header like we already do for logs and metrics.

Refs [sentry-docs#19854](getsentry/sentry-docs#19854)
0xadam-brown added a commit to getsentry/sentry-java that referenced this pull request Oct 15, 2026
Prior to this commit, `ClientReportRecorder` didn't have any explicit logic for dealing with span envelopes because sentry-java didn't implement them. That meant that any span envelopes created by hybrid SDKs (in particular sentry-dart) and dropped by sentry-java would be shunted to the recorder's fallback branch and wrongly record a single dropped span per dropped envelope, rather than the actual number.

This commit fixes that by adding the missing span envelope logic. Now sentry-java will report the actual span count, rather than 1.

Refs [sentry-docs#19854](getsentry/sentry-docs#19854)
0xadam-brown added a commit to getsentry/sentry-java that referenced this pull request Oct 15, 2026
Prior to this commit, `ClientReportRecorder` didn't have any explicit logic for dealing with span envelopes because sentry-java didn't implement them. That meant that any span envelopes created by hybrid SDKs (in particular sentry-dart) and dropped by sentry-java would be shunted to the recorder's fallback branch and wrongly register a single dropped span per dropped envelope, rather than the actual number.

This commit fixes that by adding the missing span envelope logic. Now sentry-java will report the actual span count, rather than 1.

Refs [sentry-docs#19854](getsentry/sentry-docs#19854)
0xadam-brown added a commit to getsentry/sentry-java that referenced this pull request Oct 15, 2026
Prior to this commit, `ClientReportRecorder` didn't have any explicit logic for dealing with span envelopes because sentry-java didn't implement them. That meant that any span envelopes created by hybrid SDKs (in particular sentry-dart) and dropped by sentry-java would be shunted to the recorder's fallback branch and wrongly register a single dropped span per dropped envelope, rather than the actual number.

This commit adds the missing span envelope logic. Now sentry-java will report the actual span count, rather than 1.

Refs [sentry-docs#19854](getsentry/sentry-docs#19854)
0xadam-brown added a commit to getsentry/sentry-java that referenced this pull request Oct 15, 2026
Prior to this commit, `ClientReportRecorder` didn't have any explicit logic for dealing with span envelopes because sentry-java didn't implement them. That meant that any span envelopes created by hybrid SDKs (in particular sentry-dart) and dropped by sentry-java would be shunted to the recorder's fallback branch and wrongly register a single dropped span per dropped envelope, rather than the actual number.

This commit adds the missing span envelope logic. Now sentry-java will report the actual span count, rather than 1.

Refs [sentry-docs#19854](getsentry/sentry-docs#19854)
0xadam-brown added a commit to getsentry/sentry-java that referenced this pull request Oct 16, 2026
Prior to this commit, `ClientReportRecorder` didn't have any explicit logic for dealing with span envelopes because sentry-java didn't implement them. That meant that any span envelopes created by hybrid SDKs (in particular sentry-dart) and dropped by sentry-java would be shunted to the recorder's fallback branch and wrongly register a single dropped span per dropped envelope, rather than the actual number.

This commit adds the missing span envelope logic. Now sentry-java will report the actual span count, rather than 1.

Refs [sentry-docs#19854](getsentry/sentry-docs#19854)

# Conflicts:
#	CHANGELOG.md

This branch was successfully deployed

1 active deployment
Preview – develop-docs — 20873a8d Deployed Oct 9, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Needs Triage The PR description is missing valid priority information sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants