-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(js/deno): Remove options xhr, history and dom from deno breadcrumbs
#9295
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Bundle ReportChanges will increase total bundle size by 279 bytes ⬆️
|
| excerpt: "" | ||
| description: "Wraps native APIs to capture breadcrumbs. (default)" | ||
| sidebar_order: 1 | ||
| notSupported: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you create a page in a guide, you do not longer need to specify for with other platforms/guides is isn't supported. You could remove the notSupported list
lizokm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for writing this doc @s1gr1d and welcome to Sentry!! This looks great overall, I just have a few small suggestions :)
| --- | ||
| title: Breadcrumbs | ||
| excerpt: "" | ||
| description: "Wraps native APIs to capture breadcrumbs. (default)" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| description: "Wraps native APIs to capture breadcrumbs. (default)" | |
| description: "Learn how the JavaScript framework Deno wraps native APIs to capture breadcrumbs." |
| This integration is [enabled by default](./../#modifying-default-integrations). | ||
|
|
||
| This integration wraps native APIs to capture breadcrumbs. By default, the Sentry SDK wraps all APIs. | ||
| You can opt-out of capturing breadcrumbs for specific parts of your application (e.g. do not capture `console.log` calls as breadcrumbs) via the options below. | ||
|
|
||
| In |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| This integration is [enabled by default](./../#modifying-default-integrations). | |
| This integration wraps native APIs to capture breadcrumbs. By default, the Sentry SDK wraps all APIs. | |
| You can opt-out of capturing breadcrumbs for specific parts of your application (e.g. do not capture `console.log` calls as breadcrumbs) via the options below. | |
| In | |
| When you're using Sentry's SDK for Deno, the breadcrumbs-capture integration wraps native APIs to capture breadcrumbs. Because the Sentry SDK wraps all APIs, this integration is enabled by default. Read about how to modify default integrations [here](./../#modifying-default-integrations). | |
| You can opt out of capturing breadcrumbs for specific parts of your application (for example, you could say don't capture `console.log` calls as breadcrumbs) via the options below. | |
We try to stay away from Latin abbreviations (eg, etc,...)
We also use contractions as much as possible (do not > don't)
:)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually find it useful to have the information that this is a default integration at the top :) I also talked to @lforst and he also thinks that having that really short at the top is better.
What do you think of that:
This integration is enabled by default. You can also modify default integrations.
The
breadcrumbsIntegrationwraps native APIs to capture breadcrumbs. By default, the Sentry SDK wraps all APIs. You can opt out of capturing breadcrumbs for specific parts of your application (for example, you could say don't captureconsole.logcalls as breadcrumbs) via the options below.
As all other pages with default integrations have this first line "This integration is enabled by default", I would modify the "base page" for integrations too in another PR - #9308 :)
|
|
||
| ### `console` | ||
|
|
||
| _Type: `boolean`_ | ||
|
|
||
| Log calls to `console.log`, `console.debug`, etc. | ||
|
|
||
| ### `fetch` | ||
|
|
||
| _Type: `boolean`_ | ||
|
|
||
| Log HTTP requests done with the Fetch API | ||
|
|
||
| ### `sentry` | ||
|
|
||
| _Type: `boolean`_ | ||
|
|
||
| Log whenever we send an event to the server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### `console` | |
| _Type: `boolean`_ | |
| Log calls to `console.log`, `console.debug`, etc. | |
| ### `fetch` | |
| _Type: `boolean`_ | |
| Log HTTP requests done with the Fetch API | |
| ### `sentry` | |
| _Type: `boolean`_ | |
| Log whenever we send an event to the server. | |
| `console` | |
| _Type: `boolean`_ | |
| Log calls to `console.log`, `console.debug`, and so on. | |
| `fetch` | |
| _Type: `boolean`_ | |
| Log HTTP requests done with the Fetch API. | |
| `sentry` | |
| _Type: `boolean`_ | |
| Log whenever we send an event to the server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we still need this, as people can directly link to the H3 of the option.
a1ea96b to
a1f0974
Compare
lizokm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just one more small tweak :)
|
|
||
| _Import name: `Sentry.breadcrumbsIntegration`_ | ||
|
|
||
| This integration is enabled by default. You can also [modify default integrations](./../#modifying-default-integrations). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| This integration is enabled by default. You can also [modify default integrations](./../#modifying-default-integrations). | |
| This integration is enabled by default. If you'd like to modify your default integrations, read [this](./../#modifying-default-integrations). |
|
|
||
| _Type: `boolean`_ | ||
|
|
||
| Log HTTP requests done with the Fetch API |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Log HTTP requests done with the Fetch API | |
| Log HTTP requests done with the Fetch API. |
Description of changes
In this PR getsentry/sentry-javascript#10867, the options
xhr,historyanddomwere removed from the breadcrumbs Integration for Deno. The base for the breadcrumbs docs file is located incommons.