Repository navigation
feat(docs): Apply new quick start template to Java quick start guides - #20002
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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.
Mention |
79fde1b to
e1ec9d0
Compare
57a1bb4 to
1ae6776
Compare
Co-Authored-By: Shannon Anahata <[email protected]>
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 <[email protected]>
653feb8 to
a9fcc22
Compare
|
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
left a comment
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
| import io.sentry.Sentry | |
| import io.sentry.Sentry; |
|
|
||
| ```java | ||
| import io.sentry.Sentry | ||
| import io.sentry.SentryAttribute |
There was a problem hiding this comment.
| import io.sentry.SentryAttribute | |
| import io.sentry.SentryAttribute; |
| ```java | ||
| import io.sentry.Sentry | ||
| import io.sentry.SentryAttribute | ||
| import io.sentry.SentryAttributes |
There was a problem hiding this comment.
| 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 |
There was a problem hiding this comment.
| 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 |
There was a problem hiding this comment.
| 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/ |
There was a problem hiding this comment.
h this should remain log4j2 otherwise we link to JUL docs
There was a problem hiding this comment.
| # 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/ |
There was a problem hiding this comment.
h same here, should remain logback otherwise we link to JUL docs
There was a problem hiding this comment.
| # 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 --> |
There was a problem hiding this comment.
| <!-- 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: |
There was a problem hiding this comment.
| 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: |
There was a problem hiding this comment.
| Install Sentry for your Spring Boot version: | |
| Install Sentry for your Spring version: |
@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.
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.<OnboardingOption>wrappers, and___PRODUCT_OPTION___markers from the Java getting-started includes.sentry-async-profilerdependency is included by default.logs.enabled=true(orsentry.logs.enabled=trueon Spring Boot). Both setup paths include it. Application Metrics need no option.IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
via shannon.anahata.
--
View Junior Session [Sentry]