Skip to content

feat(docs): Update quick start guide template - #19295

Draft
inventarSarah wants to merge 1 commit into
masterfrom
smi/play/quick-start/default-features
Draft

feat(docs): Update quick start guide template#19295
inventarSarah wants to merge 1 commit into
masterfrom
smi/play/quick-start/default-features

Conversation

@inventarSarah

@inventarSarah inventarSarah commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

Drafted an updated version for our quick start guides -> see the Ember guide.

@sfanahata I suggest we work on this until we have a version we're happy with and then get the SDK teams involved. If you want, you can pull this branch and add your own ideas.

Changes:

  • moved onboarding options down to "Initialize SDK" and updated the description above it
    • I didn't change anything else about the options
  • added 2 new h2 sections for Logs and Metrics
    • I didn't see any logging integrations for JS -> if there were, I'd have added them to this new Logs section
  • removed Logs (and metrics) from the Verify section (verify if you've configured things correctly; logs+metrics are enabled by default; if users want to verify these, they can use the examples provided in the code snippets in the same guide)
  • left logs and metrics in the expandables (Want to learn more; Need help locating data in Sentry)
  • cleaned up next steps (only 3 left -- I think that's a good number):
    • removed product links (we already link to these pages in the feature expandable)
    • added a link to Agent Tracing
    • removed link to capture errors manually

Reminder: logs still need to be set via enable_logs for some SDKs (eg JavaScript's Electron)

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+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • 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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel

vercel Bot commented Sep 8, 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 Sep 8, 2026 12:22pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Sep 8, 2026 12:22pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Sep 8, 2026

## Send Logs (Optional)

<PlatformLink to="/logs/">Logs</PlatformLink> are enabled by default and let you send, view, and query logs from your app within Sentry.

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.

Suggested change
<PlatformLink to="/logs/">Logs</PlatformLink> are enabled by default and let you send, view, and query logs from your app within Sentry.
Logs are enabled by default and let you send, view, and query logs from your app within Sentry.

<SplitSectionText>

Use `Sentry.logger` to send logs at different levels, such as `info` or `warn`, and attach a message.
You can pass any attributes you want and search or filter by them later.

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.

Suggested change
You can pass any attributes you want and search or filter by them later.
You can pass any attributes you want and search or filter by them later. See <PlatformLink to="/logs/">Set Up Logs</PlatformLink> for all available logging methods and the syntax for formatting messages.


## Send Application Metrics (Optional) <FeatureBadge type="new" />

<PlatformLink to="/metrics/">Application Metrics</PlatformLink> are enabled by default and allow you to send, view, and query various metrics from your app.

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.

Suggested change
<PlatformLink to="/metrics/">Application Metrics</PlatformLink> are enabled by default and allow you to send, view, and query various metrics from your app.
Application Metrics are enabled by default and allow you to send, view, and query various metrics from your app.

<SplitSectionText>

Use `Sentry.metrics` to send counters, gauges, and distributions from your app to Sentry.
You can pass any attributes you want and search or filter by them later.

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.

Suggested change
You can pass any attributes you want and search or filter by them later.
You can pass any attributes you want and search or filter by them later. See <PlatformLink to="/metrics/">Set Up Metrics</PlatformLink> for all available metric types and configuration options.

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

I think this works with some minor suggested changes. I'll leave the final decision in @sfanahata 's hands.

Choose the features you want to configure, and this guide will show you how:
### Initialize the SDK

Initializing the Sentry SDK enables core features such as Error Monitoring, Logs, and Application Metrics by default. While Sentry automatically reports errors, you'll need to send logs and metrics manually, as you'll learn further down.

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.

Suggested change
Initializing the Sentry SDK enables core features such as Error Monitoring, Logs, and Application Metrics by default. While Sentry automatically reports errors, you'll need to send logs and metrics manually, as you'll learn further down.
Initializing the Sentry SDK enables core features such as Error Monitoring, Logs, and Application Metrics by default. While Sentry automatically reports errors, you'll need to send logs and metrics manually. We'll show you how that works in steps [#3](#send-logs-optional) and [#4](#send-application-metrics-optional-)


Initializing the Sentry SDK enables core features such as Error Monitoring, Logs, and Application Metrics by default. While Sentry automatically reports errors, you'll need to send logs and metrics manually, as you'll learn further down.

Choose additional features you want to configure, and this guide will show you how:

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.

Suggested change
Choose additional features you want to configure, and this guide will show you how:
Choose additional features you want to configure, and this guide will show you how to get set up:

Comment on lines 40 to 42

<OnboardingOptionButtons
options={[

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.

It's not the worst experience, but something still feels off about having the error monitoring button greyed out, while excluding logs and app metrics from this list. I wonder if we get rid of the error monitoring button since we share that "
Initializing the Sentry SDK enables core features such as Error Monitoring, Logs, and Application Metrics by default." at the top of the section?

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