Skip to content

add apollo5 docs to android and java - #19558

Open
lbloder wants to merge 4 commits into
masterfrom
lbloder/apollo5
Open

lbloder wants to merge 4 commits into
masterfrom
lbloder/apollo5

Conversation

@lbloder

@lbloder lbloder commented Sep 22, 2026

Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

Docs for the apollo5 integration implemented in getsentry/sentry-java#6074

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

@vercel

vercel Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Error Error Oct 13, 2026 9:37am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 13, 2026 9:37am UTC

Request Review

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Sep 22, 2026
@codeowner-assignment
codeowner-assignment Bot requested review from a team September 22, 2026 13:56

@adinauer adinauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Mostly LGTM, just one comment

ApolloClient apollo = SentryApolloBuilderExtensionsKt.sentryTracing(
new ApolloClient.Builder(),
true,
Collections.singletonList(SentryOptions.DEFAULT_PROPAGATION_TARGETS),

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: DEFAULT_PROPAGATION_TARGETS is marked internal. We could just provide a custom list as sample here or hard code the .* value. Or we open up the default constant.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Actually, i think i'll remove it. Since we don't show that parameter in the apollo-4 docs or in the kotlin version of this one. WDYT?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

actually, that is an issue in the apollo-4 docs. have a list of issues with the apollo3 and 4 docs, that get their own issue and pr. Went with ".*"

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 2, 2026 09:28
@lbloder
lbloder marked this pull request as ready for review October 5, 2026 08:57
@github-actions

github-actions Bot commented Oct 5, 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.

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 5, 2026 08:58
@cursor

cursor Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks new Apollo 5 page loads and existing Apollo page loads.
It also checks client errors on those sibling paths.
An issue escalates when sibling pages stop loading or those errors rise.

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Requests to /platforms/android/integrations/apollo5/ now return Apollo 5 install and tracing steps.
Requests to /platforms/java/tracing/instrumentation/apollo5/ now return the same steps.
Spring, Spring Boot, and Servlet guide paths inherit the Java page.
sentry-docs must deploy before this change is live.

Risk

A bad MDX file can fail static generation for the new paths.
A Java common-file error can also hide the inherited guide pages.
New code tabs can throw client errors on those pages.
A bad version inject can show a wrong install version.

Intended effect

The new paths start to record page loads.
absent looks like existing Apollo paths still record page loads while every Apollo 5 path stays at zero.

Signal Baseline Rule Source
docs.page.load on path:*apollo5* 0 loads rise above 0 Sentry org sentry project docs, production, 2026-10-04T08:58:00Z to 2026-10-05T08:58:00Z. Query metric.name:docs.page.load environment:production path:*apollo5*

Regression watch

This change can break sibling Apollo pages and other pages in the same path families.
Watch page loads on existing Apollo paths.
Watch client errors on Android integration urls and Java instrumentation urls.

Signal Baseline Rule Source
docs.page.load on path:*apollo* 15 loads in 24h. Per path 1-3. hold per-path 1-3. Escalate if the family total falls to 0. Sentry org sentry project docs, production, 2026-10-04T08:58:00Z to 2026-10-05T08:58:00Z. Query metric.name:docs.page.load environment:production path:*apollo*
docs.page.load on path:*/platforms/android/integrations/* 16 loads in 24h Escalate if this family falls to 0. Same project and window. Query metric.name:docs.page.load environment:production path:*/platforms/android/integrations/*
production errors on url:*/platforms/android/integrations/* or url:*/platforms/java/tracing/instrumentation/* 14 errors in 24h. 37 errors in 7d. About 5-14 errors per 24h. hold 5-14 errors per 24h. Escalate if the 24h count rises above 14. Sentry org sentry project docs, production. 24h window 2026-10-04T08:58:00Z to 2026-10-05T08:58:00Z. 7d window 2026-09-28T08:58:00Z to 2026-10-05T08:58:00Z. Query environment:production (url:*/platforms/android/integrations/* OR url:*/platforms/java/tracing/instrumentation/*)

Not observable

Pageload span searches by transaction name returned no rows.
The new install snippets have no correctness signal.
Sidebar discovery without a page load is not measured.

Comment thread docs/platforms/java/common/tracing/instrumentation/apollo5.mdx
Comment thread docs/platforms/java/common/tracing/instrumentation/apollo5.mdx

<Alert>

To capture transactions, first <PlatformLink to="/tracing/">set up tracing</PlatformLink>.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are we still using the term "transactions" for this type of data?


<Alert>

To capture transactions, first <PlatformLink to="/tracing/">set up tracing</PlatformLink>.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same question about transactions

@sfanahata sfanahata left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good from a formatting and general content perspective. Will leave to the experts on when it's ready to merge and accuracy.

This branch had an error being deployed

1 failed and 1 active (outdated) deployments
Preview – sentry-docs — bf4d9dcc Deployed Oct 13, 2026 by vercel[bot]
Preview – develop-docs — 971de24b Deployed Sep 29, 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants