Skip to content

Conversation

@s1gr1d
Copy link
Member

@s1gr1d s1gr1d commented Mar 1, 2024

Description of changes

In this PR getsentry/sentry-javascript#10867, the options xhr, history and dom were removed from the breadcrumbs Integration for Deno. The base for the breadcrumbs docs file is located in commons.

@vercel
Copy link

vercel bot commented Mar 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 5, 2024 1:18pm

@s1gr1d s1gr1d requested a review from lizokm March 1, 2024 10:10
@codecov
Copy link

codecov bot commented Mar 1, 2024

Bundle Report

Changes will increase total bundle size by 279 bytes ⬆️

Bundle name Size Change
sentry-docs-server 5.93MB 285 bytes ⬆️
sentry-docs-edge-server 3.47kB 0 bytes
sentry-docs-client 5.51MB 6 bytes ⬇️

excerpt: ""
description: "Wraps native APIs to capture breadcrumbs. (default)"
sidebar_order: 1
notSupported:
Copy link
Contributor

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

Copy link
Contributor

@lizokm lizokm left a 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)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: "Wraps native APIs to capture breadcrumbs. (default)"
description: "Learn how the JavaScript framework Deno wraps native APIs to capture breadcrumbs."

Comment on lines 12 to 17
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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)
:)

Copy link
Member Author

@s1gr1d s1gr1d Mar 4, 2024

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 breadcrumbsIntegration 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 (for example, you could say don't capture console.log calls 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 :)

Comment on lines 20 to 33

### `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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### `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.

Copy link
Member Author

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.

Copy link
Contributor

@lizokm lizokm left a 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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Log HTTP requests done with the Fetch API
Log HTTP requests done with the Fetch API.

@s1gr1d s1gr1d self-assigned this Mar 5, 2024
@s1gr1d s1gr1d enabled auto-merge (squash) March 5, 2024 13:05
@s1gr1d s1gr1d merged commit 1bfe031 into master Mar 5, 2024
@s1gr1d s1gr1d deleted the sig-deno-breadcrumbs branch March 5, 2024 13:18
@github-actions github-actions bot locked and limited conversation to collaborators Mar 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants