Skip to content

Commit

Permalink
feat(js): Add docs for generic pool integration (#11305)
Browse files Browse the repository at this point in the history 
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
  • Loading branch information
@AbhiPrasad @vivianyentran
AbhiPrasad and vivianyentran authored Sep 13, 2024
1 parent 1ddf1fc commit 3415ceb
Show file tree
Hide file tree
Showing 13 changed files with 50 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/genericpool.mdx
View file
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

- `generic-pool`: `>=2.0.0 <4`
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.astro.mdx
View file
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
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
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
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
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
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
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
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
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
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
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
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

0 comments on commit 3415ceb

Please sign in to comment.