Skip to content

Commit 2f2fed8

Browse files
AbhiPrasadAbhiPrasad
authored
feat(js): Document kafkajs integration (#11350)
1 parent 653a941 commit 2f2fed8

File tree

13 files changed

+50
-0
lines changed

13 files changed

+50
-0
lines changed

‎docs/platforms/javascript/common/configuration/integrations/kafka.mdx

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Kafka
3+
description: "Adds instrumentation for KafkaJS. (default)"
4+
supported:
5+
- javascript.node
6+
- javascript.aws-lambda
7+
- javascript.azure-functions
8+
- javascript.connect
9+
- javascript.express
10+
- javascript.fastify
11+
- javascript.gcp-functions
12+
- javascript.hapi
13+
- javascript.koa
14+
- javascript.nestjs
15+
- javascript.electron
16+
- javascript.nextjs
17+
- javascript.nuxt
18+
- javascript.sveltekit
19+
- javascript.remix
20+
- javascript.astro
21+
- javascript.bun
22+
---
23+
24+
<Alert level="info">
25+
26+
This integration only works in the Node.js and Bun runtimes. Requires SDK version `8.30.0` or higher.
27+
28+
</Alert>
29+
30+
_Import name: `Sentry.kafkaIntegration`_
31+
32+
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).
33+
34+
The `kafkaIntegration` adds instrumentation for the `kafkajs` library to capture spans using [`@opentelemetry/instrumentation-kafkajs`](https://www.npmjs.com/package/@opentelemetry/instrumentation-kafkajs).
35+
36+
## Supported Versions
37+
38+
- `kafkajs`: `>=0.1.0 <3`

‎platform-includes/configuration/integrations/javascript.astro.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
4646
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
4747
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
4848
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
49+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
4950
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
5051
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
5152
| [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

‎platform-includes/configuration/integrations/javascript.aws-lambda.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
| [`extraErrorDataIntegration`](./extraerrordata) | | | | ✓ |
2323
| [`genericPoolIntegration`](./genericpool) | | | ✓ | |
2424
| [`graphqlIntegration`](./graphql) | | | ✓ | |
25+
| [`kafkaIntegration`](./kafka) | | | ✓ | |
2526
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
2627
| [`mongoIntegration`](./mongo) | | | ✓ | |
2728
| [`mongooseIntegration`](./mongoose) | | | ✓ | |

‎platform-includes/configuration/integrations/javascript.bun.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
| [`functionToStringIntegration`](./functiontostring) | ✓ | | | |
1010
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
1111
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
12+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
1213
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
1314
| [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
1415
| [`linkedErrorsIntegration`](./linkederrors) | ✓ | ✓ | | |

‎platform-includes/configuration/integrations/javascript.fastify.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
99
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
1010
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
11+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
1112
| [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
1213
| [`linkedErrorsIntegration`](./linkederrors) | ✓ | ✓ | | |
1314
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |

‎platform-includes/configuration/integrations/javascript.gcp-functions.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
| [`extraErrorDataIntegration`](./extraerrordata) | | | | ✓ |
2323
| [`genericPoolIntegration`](./genericpool) | | | ✓ | |
2424
| [`graphqlIntegration`](./graphql) | | | ✓ | |
25+
| [`kafkaIntegration`](./kafka) | | | ✓ | |
2526
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
2627
| [`mongoIntegration`](./mongo) | | | ✓ | |
2728
| [`mongooseIntegration`](./mongoose) | | | ✓ | |

‎platform-includes/configuration/integrations/javascript.nestjs.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
1111
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
1212
| [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
13+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
1314
| [`linkedErrorsIntegration`](./linkederrors) | ✓ | ✓ | | |
1415
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
1516
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |

‎platform-includes/configuration/integrations/javascript.nextjs.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Depending on whether an integration enhances the functionality of a particular r
5353
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
5454
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
5555
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
56+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
5657
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
5758
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
5859
| [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

‎platform-includes/configuration/integrations/javascript.node.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
1111
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
1212
| [`inboundFiltersIntegration`](./inboundfilters) | ✓ | ✓ | | |
13+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
1314
| [`linkedErrorsIntegration`](./linkederrors) | ✓ | ✓ | | |
1415
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
1516
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |

‎platform-includes/configuration/integrations/javascript.nuxt.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
4646
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
4747
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
4848
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
49+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
4950
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
5051
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
5152
| [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

‎platform-includes/configuration/integrations/javascript.remix.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
4646
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
4747
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
4848
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
49+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
4950
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
5051
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
5152
| [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

‎platform-includes/configuration/integrations/javascript.solidstart.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
4646
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
4747
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
4848
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
49+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
4950
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
5051
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
5152
| [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

‎platform-includes/configuration/integrations/javascript.sveltekit.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Depending on whether an integration enhances the functionality of a particular r
4646
| [`httpIntegration`](./http) | ✓ | ✓ | ✓ | ✓ |
4747
| [`genericPoolIntegration`](./genericpool) | ✓ | | ✓ | |
4848
| [`graphqlIntegration`](./graphql) | ✓ | | ✓ | |
49+
| [`kafkaIntegration`](./kafka) | ✓ | | ✓ | |
4950
| [`modulesIntegration`](./modules) | ✓ | | | ✓ |
5051
| [`mongoIntegration`](./mongo) | ✓ | | ✓ | |
5152
| [`mongooseIntegration`](./mongoose) | ✓ | | ✓ | |

0 commit comments

Comments
 (0)