feat(docs): Update quick start guide template - #19295
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
|
||
| ## 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. |
There was a problem hiding this comment.
| <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. |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
| <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. |
There was a problem hiding this comment.
| 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
left a comment
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
| 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: |
There was a problem hiding this comment.
| 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: |
|
|
||
| <OnboardingOptionButtons | ||
| options={[ |
There was a problem hiding this comment.
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?
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:
Reminder: logs still need to be set via
enable_logsfor 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-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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