Skip to content
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.

Sign up for GitHub

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

feat(js): Add docs for generic pool integration #11305

Merged
merged 3 commits into from
Sep 13, 2024
Merged

feat(js): Add docs for generic pool integration #11305

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82595df
feat(js): Add docs for generic pool integration
AbhiPrasad Sep 10, 2024
88463f8
Apply suggestions from code review
AbhiPrasad Sep 13, 2024
b05d989
Update docs/platforms/javascript/common/configuration/integrations/ge…
AbhiPrasad Sep 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/genericpool.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Generic Pool
description: "Adds instrumentation for Generic Pool. (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.nuxt
- javascript.sveltekit
- javascript.remix
- javascript.astro
- javascript.bun
---

<Alert level="info">

This integration only works in the Node.js and Bun runtimes. Requires SDK version `8.29.0` or higher.

</Alert>

_Import name: `Sentry.genericPoolIntegration`_

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 `genericPoolIntegration` adds instrumentation for the `generic-pool` library to capture spans using [`@opentelemetry/instrumentation-generic-pool`](https://www.npmjs.com/package/@opentelemetry/instrumentation-generic-pool).

## Supported Versions

- `mongoose`: `>=2.0.0 <4`
Copy link
Contributor

Choose a reason for hiding this comment

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

Just want to double check that this should be mongoose

Copy link
Member Author

Choose a reason for hiding this comment

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

it should not! sorry for that.

1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.astro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`consoleIntegration`](./console) | ✓ | | | ✓ |
| [`contextLinesIntegration`](./contextlines) | ✓ | ✓ | | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.aws-lambda.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
| [`captureConsoleIntegration`](./captureconsole) | | | | ✓ |
| [`debugIntegration`](./debug) | | | | |
| [`extraErrorDataIntegration`](./extraerrordata) | | | | ✓ |
| [`genericPoolIntegration`](./genericpool) | | | ✓ | |
| [`graphqlIntegration`](./graphql) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`mongoIntegration`](./mongo) | | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.bun.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
| [`contextLinesIntegration`](./contextlines) | ✓ | ✓ | | |
| [`dedupeIntegration`](./dedupe) | ✓ | ✓ | | |
| [`functionToStringIntegration`](./functiontostring) | ✓ | | | |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.fastify.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
| [`consoleIntegration`](./console) | ✓ | | | ✓ |
| [`dedupeIntegration`](./dedupe) | ✓ | ✓ | | |
| [`functionToStringIntegration`](./functiontostring) | ✓ | | | |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.gcp-functions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
| [`captureConsoleIntegration`](./captureconsole) | | | | ✓ |
| [`debugIntegration`](./debug) | | | | |
| [`extraErrorDataIntegration`](./extraerrordata) | | | | ✓ |
| [`genericPoolIntegration`](./genericpool) | | | ✓ | |
| [`graphqlIntegration`](./graphql) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`mongoIntegration`](./mongo) | | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.nestjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
| [`contextLinesIntegration`](./contextlines) | ✓ | ✓ | | |
| [`dedupeIntegration`](./dedupe) | ✓ | ✓ | | |
| [`functionToStringIntegration`](./functiontostring) | ✓ | | | |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.nextjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`consoleIntegration`](./console) | ✓ | | | ✓ |
| [`contextLinesIntegration`](./contextlines) | ✓ | ✓ | | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
| [`contextLinesIntegration`](./contextlines) | ✓ | ✓ | | |
| [`dedupeIntegration`](./dedupe) | ✓ | ✓ | | |
| [`functionToStringIntegration`](./functiontostring) | ✓ | | | |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.nuxt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`consoleIntegration`](./console) | ✓ | | | ✓ |
| [`contextLinesIntegration`](./contextlines) | ✓ | ✓ | | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.remix.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`consoleIntegration`](./console) | ✓ | | | ✓ |
| [`contextLinesIntegration`](./contextlines) | ✓ | ✓ | | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.solidstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`consoleIntegration`](./console) | ✓ | | | ✓ |
| [`contextLinesIntegration`](./contextlines) | ✓ | ✓ | | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.sveltekit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`consoleIntegration`](./console) | ✓ | | | ✓ |
| [`contextLinesIntegration`](./contextlines) | ✓ | ✓ | | |
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
Expand Down
Loading