-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Revamp JS integrations page for v8 (#10138)
- Loading branch information
1 parent
20742c1
commit 6101daf
Showing
83 changed files
with
1,659 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
docs/platforms/javascript/common/configuration/integrations/anr.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: Anr | ||
description: "Capture context about the environment and the device that the client is running on, and add it to events. (default)" | ||
supported: | ||
- javascript.node | ||
- javascript.aws-lambda | ||
- javascript.azure-functions | ||
- javascript.connect | ||
- javascript.express | ||
- javascript.fastify | ||
- javascript.gcp-functions | ||
- javascript.hapi | ||
- javascript.koa | ||
- javascript.nestjs | ||
- javascript.electron | ||
- javascript.nextjs | ||
- javascript.sveltekit | ||
- javascript.remix | ||
- javascript.astro | ||
--- | ||
|
||
<Alert level="info"> | ||
|
||
This integration only works in the Node.js runtime. | ||
|
||
</Alert> | ||
|
||
_Import name: `Sentry.anrIntegration`_ | ||
|
||
The `anrIntegration` captures Application Not Responding (ANR)/Event Loop Stall errors and reports them as Sentry events. For more details, see the documentation on [ANR](../../application-not-responding). |
12 changes: 12 additions & 0 deletions
12
docs/platforms/javascript/common/configuration/integrations/aws.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Aws | ||
description: "Adds instrumentation for aws-sdk. (default)" | ||
supported: | ||
- javascript.aws-lambda | ||
--- | ||
|
||
_Import name: `Sentry.awsIntegration`_ | ||
|
||
This integration is enabled by default. If you'd like to modify your default integrations, read [this](./../#modifying-default-integrations). | ||
|
||
Adds instrumentation for aws-sdk v2 and v3 to automatically create spans. Powered by [`@opentelemetry/instrumentation-aws-sdk`](https://www.npmjs.com/package/@opentelemetry/instrumentation-aws-sdk). |
12 changes: 12 additions & 0 deletions
12
docs/platforms/javascript/common/configuration/integrations/awslambda.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: AwsLambda | ||
description: "Adds instrumentation for AWS Lambda. (default)" | ||
supported: | ||
- javascript.aws-lambda | ||
--- | ||
|
||
_Import name: `Sentry.awsLambdaIntegration`_ | ||
|
||
This integration is enabled by default. If you'd like to modify your default integrations, read [this](./../#modifying-default-integrations). | ||
|
||
Adds instrumentation for AWS Lambda to automatically create spans. Powered by [`@opentelemetry/instrumentation-aws-lambda`](https://www.npmjs.com/package/@opentelemetry/instrumentation-aws-lambda). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
docs/platforms/javascript/common/configuration/integrations/browserapierrors.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
--- | ||
title: BrowserApiErrors | ||
description: "Wraps native time and events APIs (`setTimeout`, `setInterval`, `requestAnimationFrame`, `addEventListener/removeEventListener`) in `try/catch` blocks to handle async exceptions. (default)" | ||
notSupported: | ||
- javascript.electron | ||
- javascript.node | ||
- javascript.aws-lambda | ||
- javascript.azure-functions | ||
- javascript.connect | ||
- javascript.express | ||
- javascript.fastify | ||
- javascript.gcp-functions | ||
- javascript.hapi | ||
- javascript.koa | ||
- javascript.nestjs | ||
- javascript.deno | ||
- javascript.bun | ||
--- | ||
|
||
<Alert level="info"> | ||
|
||
This integration only works inside a browser environment. | ||
|
||
</Alert> | ||
|
||
_Import name: `Sentry.browserApiErrorsIntegration`_ | ||
|
||
This integration is enabled by default. If you'd like to modify your default integrations, read [this](./../#modifying-default-integrations). | ||
|
||
This integration wraps native time and event APIs (`setTimeout`, `setInterval`, `requestAnimationFrame`, `addEventListener/removeEventListener`) in `try/catch` blocks to handle async exceptions. | ||
|
||
```JavaScript | ||
Sentry.init({ | ||
integrations: [ | ||
Sentry.browserApiErrorsIntegration({ | ||
setTimeout: true; | ||
setInterval: true; | ||
requestAnimationFrame: true; | ||
XMLHttpRequest: true; | ||
eventTarget: true; | ||
}), | ||
], | ||
}); | ||
``` | ||
|
||
## Options | ||
|
||
### `setTimeout` | ||
|
||
_Type: `boolean`_ | ||
|
||
Instrument the `setTimeout` browser built-in method. | ||
|
||
### `setInterval` | ||
|
||
_Type: `boolean`_ | ||
|
||
Instrument the `setInterval` browser built-in method. | ||
|
||
### `requestAnimationFrame` | ||
|
||
_Type: `boolean`_ | ||
|
||
Instrument the `requestAnimationFrame` browser built-in method. | ||
|
||
### `XMLHttpRequest` | ||
|
||
_Type: `boolean`_ | ||
|
||
Instrument the `XMLHttpRequest` browser built-in method. | ||
|
||
### `eventTarget` | ||
|
||
_Type: `boolean | string[]`_ | ||
|
||
Instrument the `addEventListener` browser built-in method for a set number of default event targets. To override the default event targets, provide an array of strings with the event target names. | ||
|
||
List of default event targets: | ||
|
||
- `EventTarget` | ||
- `Window` | ||
- `Node` | ||
- `ApplicationCache` | ||
- `AudioTrackList` | ||
- `BroadcastChannel` | ||
- `ChannelMergerNode` | ||
- `CryptoOperation` | ||
- `EventSource` | ||
- `FileReader` | ||
- `HTMLUnknownElement` | ||
- `IDBDatabase` | ||
- `IDBRequest` | ||
- `IDBTransaction` | ||
- `KeyOperation` | ||
- `MediaController` | ||
- `MessagePort` | ||
- `ModalWindow` | ||
- `Notification` | ||
- `SVGElementInstance` | ||
- `Screen` | ||
- `SharedWorker` | ||
- `TextTrack` | ||
- `TextTrackCue` | ||
- `TextTrackList` | ||
- `WebSocket` | ||
- `WebSocketWorker` | ||
- `Worker` | ||
- `XMLHttpRequest` | ||
- `XMLHttpRequestEventTarget` | ||
- `XMLHttpRequestUpload` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
docs/platforms/javascript/common/configuration/integrations/bunserver.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: BunServer | ||
description: "Instruments Bun.serve to automatically create transactions and capture errors. (default)" | ||
supported: | ||
- javascript.bun | ||
--- | ||
|
||
<Alert level="info"> | ||
|
||
This integration only works in the Bun runtime. | ||
|
||
</Alert> | ||
|
||
_Import name: `Sentry.bunServerIntegration`_ | ||
|
||
This integration is enabled by default. If you'd like to modify your default integrations, read [this](./../#modifying-default-integrations). | ||
|
||
The `bunServerIntegration` instruments [`Bun.serve` API](https://bun.sh/docs/api/http) to automatically create transactions and capture errors. |
25 changes: 25 additions & 0 deletions
25
docs/platforms/javascript/common/configuration/integrations/connect.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: Connect | ||
description: "Adds performance instrumentation for Connect. (default)" | ||
supported: | ||
- javascript.node | ||
- javascript.hapi | ||
--- | ||
|
||
For more information on setting up Sentry Connect support, see the [Connect Sentry documentation](/platforms/javascript/guides/connect/). | ||
|
||
<Alert level="info"> | ||
|
||
This integration only works in the Node.js and Bun runtimes. | ||
|
||
</Alert> | ||
|
||
_Import name: `Sentry.connectIntegration`_ | ||
|
||
This integration is enabled by default when performance monitoring is enabled. If you'd like to modify your default integrations, read [this](./../#modifying-default-integrations). | ||
|
||
The `connectIntegration` adds instrumentation for the Hapi framework to capture spans using [`@opentelemetry/instrumentation-connect`](https://www.npmjs.com/package/@opentelemetry/instrumentation-connect). | ||
|
||
## Supported Versions | ||
|
||
- Connect `^3.0.0` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 14 additions & 0 deletions
14
docs/platforms/javascript/common/configuration/integrations/contextlines.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
docs/platforms/javascript/common/configuration/integrations/denocontext.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: DenoContext | ||
description: "Capture context about the environment and the device that the client is running on, and add it to events. (default)" | ||
supported: | ||
- javascript.deno | ||
--- | ||
|
||
<Alert level="info"> | ||
|
||
This integration only works in the Deno runtime. | ||
|
||
</Alert> | ||
|
||
_Import name: `Sentry.denoContextIntegration`_ | ||
|
||
This integration is enabled by default. If you'd like to modify your default integrations, read [this](./../#modifying-default-integrations). | ||
|
||
Adds Deno related context to events. This includes contexts about `app`, `device`, `os`, `v8`, and `TypeScript`. |
Oops, something went wrong.