Skip to content

feat(docs): Apply new quick start template to Java quick start guides - #20002

Open
sentry-junior[bot] wants to merge 3 commits into
masterfrom
docs/quickstart-template-java
Open

sentry-junior[bot] wants to merge 3 commits into
masterfrom
docs/quickstart-template-java

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Applies the quick start template from #19295 (Ember) to the Java quick start (common/index.mdx, which also renders for the JUL, Log4j2, Logback, and Servlet guides) and the Spring Boot and Spring guides. All pages keep their single-column layout.

  • Removes the onboarding option checkboxes, <OnboardingOption> wrappers, and ___PRODUCT_OPTION___ markers from the Java getting-started includes.
  • The Sentry OpenTelemetry agent setup is the default path (it was the default checked option). The full plain SDK setup, without the agent, is in a collapsed "Not using OpenTelemetry?" expandable on the same page, since there's no standalone plain-SDK setup page to link to. Links to the OpenTelemetry agent and agentless setup docs are included.
  • Configure names the features the guide sets up (Error Monitoring, Tracing, Profiling, Logs, Application Metrics). Snippets include all options by default, with a note that unwanted ones can be removed. The sentry-async-profiler dependency is included by default.
  • Logs need an explicit option: logs.enabled=true (or sentry.logs.enabled=true on Spring Boot). Both setup paths include it. Application Metrics need no option.
  • Adds Send Logs (with links to the JUL, Log4j2, Logback, and Spring Boot logging integrations) and Send Application Metrics as their own steps, and simplifies Verify.

IS YOUR CHANGE URGENT?

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

PRE-MERGE CHECKLIST

  • 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

via shannon.anahata.

--

View Junior Session [Sentry]

sentry-junior Bot and others added 2 commits October 15, 2026 01:00
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
The Spring and Spring Boot pages had an include placed above the
frontmatter, and no Java prerequisites include exists. Also put the
Send Logs snippet before the integration links.

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
@vercel

vercel Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 15, 2026 2:56pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 15, 2026 2:56pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 15, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 15, 2026 14:49
@cursor

cursor Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks Java getting-started page loads, snippet copies, Java 404s, and client errors on those pages. An issue escalates when those page loads fall or Java 404s appear. It also splits page loads for the Spring Boot guide and the Java root guide.

Services: sentry-docs.

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

Plan

What changed

Java getting-started pages now show a numbered step guide. The steps are Install, Configure, Send Logs, Send Application Metrics, and Verify Your Setup. Configure uses the OpenTelemetry agent by default. The plain SDK setup sits in an expandable titled Not using OpenTelemetry. The onboarding option checkboxes are gone. JUL, Log4j2, Logback, and Servlet share the common Java guide. Spring Boot and Spring have their own guides. sentry-docs must deploy before this change is live.

Risk

A broken include can blank the Install or Configure snippets on all seven guides. A StepConnector or Expandable fault can throw in the browser on those pages. Readers who skip OpenTelemetry may miss the collapsed setup. A bad internal link can 404 other Java pages.

Intended effect

The seven getting-started URLs must keep loading. That is the proof the new step layout is on the live pages. Absent looks like those loads fall below the band while the Java configuration page still loads. Snippet copies on Java docs must also hold. Absent copies with steady loads means the new code blocks are not usable.

docs.page.load is a client counter on each page. Filter environment:production and this path list: /platforms/java/, /platforms/java/guides/spring-boot/, /platforms/java/guides/spring/, /platforms/java/guides/jul/, /platforms/java/guides/log4j2/, /platforms/java/guides/logback/, /platforms/java/guides/servlet/.

docs.snippet_copy uses page_path:/platforms/java. That attribute is the first three path segments. It covers all Java docs pages, not only the seven guides.

Signal Baseline Window Rule Source
Combined getting-started docs.page.load 77 loads in current 24h. 82 loads in prior 24h. Band 70-90 per 24h. 2026-10-14T14:49:39Z to 2026-10-15T14:49:39Z and 2026-10-13T14:49:39Z to 2026-10-14T14:49:39Z Hold inside 70-90 per 24h. Absent if the total falls below 70 while configuration loads hold. Sentry org sentry project docs. Metric docs.page.load.
Spring Boot getting-started docs.page.load 35 loads in current 24h. 40 loads in prior 24h. Band 32-43 per 24h. Same two 24h windows Hold inside 32-43 per 24h on /platforms/java/guides/spring-boot/. Same metric. Path /platforms/java/guides/spring-boot/.
Java root getting-started docs.page.load 25 loads in current 24h. 28 loads in prior 24h. Band 22-31 per 24h. Same two 24h windows Hold inside 22-31 per 24h on /platforms/java/. Same metric. Path /platforms/java/.
Java docs.snippet_copy 3 copies in current 24h. 4 copies in prior 24h. Share 3.9-4.9% of combined getting-started loads. Band 2-6 copies per 24h. Same two 24h windows Hold 2-6 copies per 24h. Absent if copies stay at 0 while getting-started loads hold. Sentry org sentry project docs. Metric docs.snippet_copy. page_path:/platforms/java.

JUL, Log4j2, Logback, Servlet, and Spring each had 1-7 loads per 24h. Do not band those paths alone. Keep them inside the combined total.

Regression watch

Watch 404s on the Java path, client errors on Java docs URLs, snippet copies, and loads on the Java configuration page. A blank getting-started page shows as a 404 or a load drop. A StepConnector or Expandable throw shows as a new error title. Broken code tabs show as snippet copies falling toward 0.

The UnhandledRejection title Object Not Found Matching Id is known browser extension noise. Do not treat that title alone as a regression.

Signal Baseline Window Rule Source
Java docs.page.not_found 0 events in current 24h. 0 events in prior 24h. Hold at 0. 2026-10-14T14:49:39Z to 2026-10-15T14:49:39Z and 2026-10-13T14:49:39Z to 2026-10-14T14:49:39Z Hold at 0. Detected if any docs.page.not_found fires with requested_path:platforms/java. Sentry org sentry project docs. Metric docs.page.not_found. This path is the first two segments, so it covers all Java 404s.
Client errors on Java docs URLs 3 events in current 24h. Titles were only Object Not Found Matching Id UnhandledRejection. Share about 3.9% of combined getting-started loads. Band 1-5 events per 24h. 2026-10-14T14:49:39Z to 2026-10-15T14:49:39Z Hold 1-5 events per 24h. Detected if count rises above 5, or a new title appears, including StepConnector or Expandable. Sentry org sentry project docs. Query environment:production http.url:*docs.sentry.io/platforms/java/* !http.url:*javascript*.
Java configuration docs.page.load 6 loads in current 24h. 7 loads in prior 24h. Band 5-8 per 24h. 2026-10-14T14:49:39Z to 2026-10-15T14:49:39Z and 2026-10-13T14:49:39Z to 2026-10-14T14:49:39Z Hold inside 5-8 per 24h on /platforms/java/configuration/. A drop with getting-started loads is a wider docs fault. A hold here with getting-started loads down points at this rewrite. Sentry org sentry project docs. Metric docs.page.load. Path /platforms/java/configuration/.
Java docs.snippet_copy 3 copies in current 24h. 4 copies in prior 24h. Band 2-6 per 24h. Same two 24h windows Hold 2-6 copies per 24h. Detected if copies fall to 0 while getting-started loads hold. Sentry org sentry project docs. Metric docs.snippet_copy. page_path:/platforms/java.

Not observable

The new heading text has no metric. Plausible Open Expandable for Not using OpenTelemetry is not in Sentry. Pageload duration and web vitals for these URLs returned no spans. Client transactions use /:path*. Traces sample at 30%. Sentry log search timed out. Whether readers find the collapsed non-OpenTelemetry setup is not measurable here.

This branch was successfully deployed

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

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants