feat(js): Document kafkajs integration (#11350)

getsentry · Sep 13, 2024 · 2f2fed8 · 2f2fed8
1 parent 653a941
commit 2f2fed8
Show file tree

Hide file tree

Showing 13 changed files with 50 additions and 0 deletions.
diff --git a/docs/platforms/javascript/common/configuration/integrations/kafka.mdx b/docs/platforms/javascript/common/configuration/integrations/kafka.mdx
@@ -0,0 +1,38 @@
+---
+title: Kafka
+description: "Adds instrumentation for KafkaJS. (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.30.0` or higher.
+
+</Alert>
+
+_Import name: `Sentry.kafkaIntegration`_
+
+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 `kafkaIntegration` adds instrumentation for the `kafkajs` library to capture spans using [`@opentelemetry/instrumentation-kafkajs`](https://www.npmjs.com/package/@opentelemetry/instrumentation-kafkajs).
+
+## Supported Versions
+
+- `kafkajs`: `>=0.1.0 <3`
diff --git a/platform-includes/configuration/integrations/javascript.astro.mdx b/platform-includes/configuration/integrations/javascript.astro.mdx
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
 | [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`modulesIntegration`](./modules) | ✓ | | | ✓ |
 | [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
 | [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

diff --git a/platform-includes/configuration/integrations/javascript.aws-lambda.mdx b/platform-includes/configuration/integrations/javascript.aws-lambda.mdx
@@ -22,6 +22,7 @@
 | [`extraErrorDataIntegration`](./extraerrordata) | | | | ✓ |
 | [`genericPoolIntegration`](./genericpool) | | | ✓ | |
 | [`graphqlIntegration`](./graphql) | | | ✓ | |
+| [`kafkaIntegration`](./kafka) | | | ✓ | |
 | [`localVariablesIntegration`](./localvariables) | | ✓ | | |
 | [`mongoIntegration`](./mongo) | | | ✓ | |
 | [`mongooseIntegration`](./mongoose) | | | ✓ | |

diff --git a/platform-includes/configuration/integrations/javascript.bun.mdx b/platform-includes/configuration/integrations/javascript.bun.mdx
@@ -9,6 +9,7 @@
 | [`functionToStringIntegration`](./functiontostring) | ✓ | | | |
 | [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
 | [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
 | [`linkedErrorsIntegration`](./linkederrors) | ✓ | ✓ | | |

diff --git a/platform-includes/configuration/integrations/javascript.fastify.mdx b/platform-includes/configuration/integrations/javascript.fastify.mdx
@@ -8,6 +8,7 @@
 | [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
 | [`linkedErrorsIntegration`](./linkederrors) | ✓ | ✓ | | |
 | [`modulesIntegration`](./modules) | ✓ | | | ✓ |

diff --git a/platform-includes/configuration/integrations/javascript.gcp-functions.mdx b/platform-includes/configuration/integrations/javascript.gcp-functions.mdx
@@ -22,6 +22,7 @@
 | [`extraErrorDataIntegration`](./extraerrordata) | | | | ✓ |
 | [`genericPoolIntegration`](./genericpool) | | | ✓ | |
 | [`graphqlIntegration`](./graphql) | | | ✓ | |
+| [`kafkaIntegration`](./kafka) | | | ✓ | |
 | [`localVariablesIntegration`](./localvariables) | | ✓ | | |
 | [`mongoIntegration`](./mongo) | | | ✓ | |
 | [`mongooseIntegration`](./mongoose) | | | ✓ | |

diff --git a/platform-includes/configuration/integrations/javascript.nestjs.mdx b/platform-includes/configuration/integrations/javascript.nestjs.mdx
@@ -10,6 +10,7 @@
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
 | [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`linkedErrorsIntegration`](./linkederrors) | ✓ | ✓ | | |
 | [`modulesIntegration`](./modules) | ✓ | | | ✓ |
 | [`mongoIntegration`](./mongo) | ✓ | | ✓ | |

diff --git a/platform-includes/configuration/integrations/javascript.nextjs.mdx b/platform-includes/configuration/integrations/javascript.nextjs.mdx
@@ -53,6 +53,7 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
 | [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`modulesIntegration`](./modules) | ✓ | | | ✓ |
 | [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
 | [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

diff --git a/platform-includes/configuration/integrations/javascript.node.mdx b/platform-includes/configuration/integrations/javascript.node.mdx
@@ -10,6 +10,7 @@
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
 | [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`linkedErrorsIntegration`](./linkederrors) | ✓ | ✓ | | |
 | [`modulesIntegration`](./modules) | ✓ | | | ✓ |
 | [`mongoIntegration`](./mongo) | ✓ | | ✓ | |

diff --git a/platform-includes/configuration/integrations/javascript.nuxt.mdx b/platform-includes/configuration/integrations/javascript.nuxt.mdx
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
 | [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`modulesIntegration`](./modules) | ✓ | | | ✓ |
 | [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
 | [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

diff --git a/platform-includes/configuration/integrations/javascript.remix.mdx b/platform-includes/configuration/integrations/javascript.remix.mdx
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
 | [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`modulesIntegration`](./modules) | ✓ | | | ✓ |
 | [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
 | [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

diff --git a/platform-includes/configuration/integrations/javascript.solidstart.mdx b/platform-includes/configuration/integrations/javascript.solidstart.mdx
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
 | [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`modulesIntegration`](./modules) | ✓ | | | ✓ |
 | [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
 | [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

diff --git a/platform-includes/configuration/integrations/javascript.sveltekit.mdx b/platform-includes/configuration/integrations/javascript.sveltekit.mdx
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
 | [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
 | [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
+| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
 | [`modulesIntegration`](./modules) | ✓ | | | ✓ |
 | [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
 | [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |