Skip to content

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

Merged
sfanahata merged 8 commits into
masterfrom
docs/quickstart-template-java
Nov 20, 2026
Merged

sfanahata merged 8 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]

@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
develop-docs Ready Ready Preview Nov 20, 2026 6:32pm UTC
sentry-docs Ready Ready Preview Nov 20, 2026 6:32pm 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

Services awaiting deployment · Rollout details

Warning

Rollouts can't watch this change after it deploys: every data source for this team needs to be signed in again, so a check has no telemetry to read. Sign in to your data sources, or ask a team admin to.

Status Service Environment
⚪ Not deployed yet sentry-docs

Mention @rollout in a comment to update the plan.

sentry-junior Bot and others added 7 commits November 10, 2026 11:40
@inventarSarah

Copy link
Copy Markdown
Collaborator

made some additional updates to the guides and also fixed some things.

One of the bigger changes: the logging integrations now have their own files and I removed profiling, metrics, etc from these pages and linked to these topics in the Next Steps section. Hope this makes sense to you.

@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.

Left some comments.
IUC we're doing this to improve docs for agents but it feels like this version is a bit overwhelming for a human user because there's a lot to read / skip now where before we had simple toggles to hide what the user doesn't care about.
Approving to unblock, maybe in the future we can make it a bit more friendly for humans again.

See <PlatformLink to="/metrics/">Set Up Metrics</PlatformLink> for all metric types and configuration options.

```java
import io.sentry.Sentry

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.

Suggested change
import io.sentry.Sentry
import io.sentry.Sentry;


```java
import io.sentry.Sentry
import io.sentry.SentryAttribute

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.

Suggested change
import io.sentry.SentryAttribute
import io.sentry.SentryAttribute;

```java
import io.sentry.Sentry
import io.sentry.SentryAttribute
import io.sentry.SentryAttributes

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.

Suggested change
import io.sentry.SentryAttributes
import io.sentry.SentryAttributes;

import io.sentry.Sentry
import io.sentry.SentryAttribute
import io.sentry.SentryAttributes
import io.sentry.metrics.MetricsUnit

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.

Suggested change
import io.sentry.metrics.MetricsUnit
import io.sentry.metrics.MetricsUnit;

import io.sentry.SentryAttribute
import io.sentry.SentryAttributes
import io.sentry.metrics.MetricsUnit
import io.sentry.metrics.SentryMetricsParameters

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.

Suggested change
import io.sentry.metrics.SentryMetricsParameters
import io.sentry.metrics.SentryMetricsParameters;


# Use Data Collection defaults but don't collect automatic user information.
# https://docs.sentry.io/platforms/java/guides/log4j2/data-management/data-collected/
# https://docs.sentry.io/platforms/java/guides/jul/data-management/data-collected/

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.

h this should remain log4j2 otherwise we link to JUL docs

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.

Suggested change
# https://docs.sentry.io/platforms/java/guides/jul/data-management/data-collected/
# https://docs.sentry.io/platforms/java/guides/log4j2/data-management/data-collected/


# Use Data Collection defaults but don't collect automatic user information.
# https://docs.sentry.io/platforms/java/guides/logback/data-management/data-collected/
# https://docs.sentry.io/platforms/java/guides/jul/data-management/data-collected/

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.

h same here, should remain logback otherwise we link to JUL docs

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.

Suggested change
# https://docs.sentry.io/platforms/java/guides/jul/data-management/data-collected/
# https://docs.sentry.io/platforms/java/guides/logback/data-management/data-collected/

<artifactId>sentry-maven-plugin</artifactId>
<version>{{@inject packages.version('sentry.java.maven-plugin', '0.0.2') }}</version>
<!-- Required to allow auto-install of Sentry SDK and Integrations -->
<!-- Required to allow auto-install of Sentry SDK and Integrations, including log4j2 -->

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.

Suggested change
<!-- Required to allow auto-install of Sentry SDK and Integrations, including log4j2 -->
<!-- Required to allow auto-install of Sentry SDK and Integrations -->

We shouldn't mention log4j2 in logback docs.

## Install

Sentry captures data by using an SDK within your application’s runtime.
Install Sentry for your Spring Boot version:

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.

Suggested change
Install Sentry for your Spring Boot version:
Install Sentry for your Spring version:

## Install

Sentry captures data by using an SDK within your application’s runtime.
Install Sentry for your Spring Boot version:

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.

Suggested change
Install Sentry for your Spring Boot version:
Install Sentry for your Spring version:

@sfanahata

Copy link
Copy Markdown
Contributor

Left some comments. IUC we're doing this to improve docs for agents but it feels like this version is a bit overwhelming for a human user because there's a lot to read / skip now where before we had simple toggles to hide what the user doesn't care about. Approving to unblock, maybe in the future we can make it a bit more friendly for humans again.

@adinauer - thanks for this insight. I agree that it's quite full now. We're looking at ways to add a true short and few-step "quick start" to the top of the page, with this longer exposition right below.

Apply adinauer's review suggestions, including the Windows profiling limitation, Java import syntax, framework links, and Spring wording. Preserve the existing page layout.

Merge master and resolve shared quick-start include conflicts by keeping both Java and PHP support.
@codeowner-assignment
codeowner-assignment Bot requested a review from a team November 20, 2026 18:25
@sfanahata
sfanahata merged commit 726d1a1 into master Nov 20, 2026
30 checks passed
@sfanahata
sfanahata deleted the docs/quickstart-template-java branch November 20, 2026 18:36

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — 35958ad5 Deployed Nov 20, 2026 by vercel[bot]
Preview – develop-docs — 35958ad5 Deployed Nov 20, 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.

3 participants