feat: Document Google Gen AI Integration #15061
There are no files selected for viewing
This file contains hidden or 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,140 @@ | ||||||||||||||||||
| --- | ||||||||||||||||||
| title: Google Gen AI | ||||||||||||||||||
| description: "Adds instrumentation for Google Gen AI SDK." | ||||||||||||||||||
| supported: | ||||||||||||||||||
| - javascript.node | ||||||||||||||||||
| - javascript.aws-lambda | ||||||||||||||||||
| - javascript.azure-functions | ||||||||||||||||||
| - javascript.connect | ||||||||||||||||||
| - javascript.express | ||||||||||||||||||
| - javascript.fastify | ||||||||||||||||||
| - javascript.gcp-functions | ||||||||||||||||||
| - javascript.hapi | ||||||||||||||||||
| - javascript.hono | ||||||||||||||||||
| - javascript.koa | ||||||||||||||||||
| - javascript.nestjs | ||||||||||||||||||
| - javascript.electron | ||||||||||||||||||
| - javascript.nextjs | ||||||||||||||||||
| - javascript.nuxt | ||||||||||||||||||
| - javascript.solidstart | ||||||||||||||||||
| - javascript.sveltekit | ||||||||||||||||||
| - javascript.react-router | ||||||||||||||||||
| - javascript.remix | ||||||||||||||||||
| - javascript.astro | ||||||||||||||||||
| - javascript.bun | ||||||||||||||||||
| - javascript.tanstackstart-react | ||||||||||||||||||
| - javascript.cloudflare | ||||||||||||||||||
| --- | ||||||||||||||||||
|
|
||||||||||||||||||
| <Alert> | ||||||||||||||||||
|
|
||||||||||||||||||
| This integration works in the Node.js, Cloudflare Workers, and Vercel Edge Functions runtimes. It requires SDK version `10.14.0` or higher. | ||||||||||||||||||
|
|
||||||||||||||||||
| </Alert> | ||||||||||||||||||
|
|
||||||||||||||||||
| _Import name: `Sentry.googleGenAIIntegration`_ | ||||||||||||||||||
|
|
||||||||||||||||||
| The `googleGenAIIntegration` adds instrumentation for the `@google/genai` SDK to capture spans by automatically wrapping Google Gen AI client calls and recording LLM interactions with configurable input/output recording. | ||||||||||||||||||
|
|
||||||||||||||||||
| <PlatformSection notSupported={["javascript.cloudflare", "javascript.nextjs"]}> | ||||||||||||||||||
| It is enabled by default and will automatically capture spans for Google Gen AI SDK method calls. You can opt-in to capture inputs and outputs by setting `recordInputs` and `recordOutputs` in the integration config: | ||||||||||||||||||
|
|
||||||||||||||||||
| ```javascript | ||||||||||||||||||
| Sentry.init({ | ||||||||||||||||||
| dsn: "____PUBLIC_DSN____", | ||||||||||||||||||
| tracesSampleRate: 1.0, | ||||||||||||||||||
| integrations: [ | ||||||||||||||||||
| Sentry.googleGenAIIntegration({ | ||||||||||||||||||
| recordInputs: true, | ||||||||||||||||||
| recordOutputs: true, | ||||||||||||||||||
| }), | ||||||||||||||||||
| ], | ||||||||||||||||||
| }); | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| </PlatformSection> | ||||||||||||||||||
|
|
||||||||||||||||||
| <PlatformSection supported={["javascript.cloudflare"]}> | ||||||||||||||||||
| For Cloudflare Workers, you need to manually instrument the Google Gen AI client using the `instrumentGoogleGenAIClient` helper: | ||||||||||||||||||
|
|
||||||||||||||||||
| ```javascript | ||||||||||||||||||
| import * as Sentry from "@sentry/cloudflare"; | ||||||||||||||||||
| import { GoogleGenAI } from "@google/genai"; | ||||||||||||||||||
|
|
||||||||||||||||||
| const genAI = new GoogleGenAI(process.env.API_KEY); | ||||||||||||||||||
|
There was a problem hiding this comment. Bug: Incorrect Environment Variable Access in Code ExamplesThe code examples for Cloudflare Workers and Next.js Edge runtime incorrectly use Additional Locations (1) |
||||||||||||||||||
| const client = Sentry.instrumentGoogleGenAIClient(genAI, { | ||||||||||||||||||
|
Comment on lines
+64
to
+65
Member
There was a problem hiding this comment. super-l: General question (not just this snippet) Is Maybe this
Suggested change
or
Suggested change
happy to go with whatever makes most sense. If
Member
Author
There was a problem hiding this comment. They use |
||||||||||||||||||
| recordInputs: true, | ||||||||||||||||||
| recordOutputs: true, | ||||||||||||||||||
| }); | ||||||||||||||||||
|
|
||||||||||||||||||
| // Use the wrapped client instead of the original genAI instance | ||||||||||||||||||
| const result = await client.models.generateContent("Hello!"); | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| </PlatformSection> | ||||||||||||||||||
|
|
||||||||||||||||||
| <PlatformSection supported={['javascript.nextjs']}> | ||||||||||||||||||
|
|
||||||||||||||||||
| This integration is automatically instrumented in the Node.js runtime. For Next.js applications using the Edge runtime, you need to manually instrument the Google Gen AI client: | ||||||||||||||||||
|
|
||||||||||||||||||
| ```javascript | ||||||||||||||||||
| import * as Sentry from "@sentry/nextjs"; | ||||||||||||||||||
| import { GoogleGenAI } from "@google/genai"; | ||||||||||||||||||
|
|
||||||||||||||||||
| const genAI = new GoogleGenAI(process.env.API_KEY); | ||||||||||||||||||
| const client = Sentry.instrumentGoogleGenAIClient(genAI, { | ||||||||||||||||||
| recordInputs: true, | ||||||||||||||||||
| recordOutputs: true, | ||||||||||||||||||
| }); | ||||||||||||||||||
|
|
||||||||||||||||||
| // Use the wrapped client instead of the original genAI instance | ||||||||||||||||||
| const result = await client.models.generateContent("Hello!"); | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| </PlatformSection> | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Options | ||||||||||||||||||
|
|
||||||||||||||||||
| ### `recordInputs` | ||||||||||||||||||
|
|
||||||||||||||||||
| _Type: `boolean`_ | ||||||||||||||||||
|
|
||||||||||||||||||
| Records inputs to Google Gen AI SDK method calls (such as prompts and messages). | ||||||||||||||||||
|
|
||||||||||||||||||
| Defaults to `true` if `sendDefaultPii` is `true`. | ||||||||||||||||||
|
|
||||||||||||||||||
| ```javascript | ||||||||||||||||||
| Sentry.init({ | ||||||||||||||||||
| integrations: [Sentry.googleGenAIIntegration({ recordInputs: true })], | ||||||||||||||||||
| }); | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| ### `recordOutputs` | ||||||||||||||||||
|
|
||||||||||||||||||
| _Type: `boolean`_ | ||||||||||||||||||
|
|
||||||||||||||||||
| Records outputs from Google Gen AI SDK method calls (such as generated text and responses). | ||||||||||||||||||
|
|
||||||||||||||||||
| Defaults to `true` if `sendDefaultPii` is `true`. | ||||||||||||||||||
|
|
||||||||||||||||||
| ```javascript | ||||||||||||||||||
| Sentry.init({ | ||||||||||||||||||
| integrations: [Sentry.googleGenAIIntegration({ recordOutputs: true })], | ||||||||||||||||||
| }); | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Configuration | ||||||||||||||||||
|
|
||||||||||||||||||
| By default this integration adds tracing support to Google Gen AI SDK method calls including: | ||||||||||||||||||
|
|
||||||||||||||||||
| - `models.generateContent()` - Make an API request to generate content with a given model. | ||||||||||||||||||
| - `models.generateContentStream()` - Make an API request to generate content with a given model and yields the response in chunks. | ||||||||||||||||||
| - `chats.create()` - Create chat sessions. | ||||||||||||||||||
| - `sendMessage()` - Send messages in chat sessions. | ||||||||||||||||||
| - `sendMessageStream()` - Stream messages in chat sessions. | ||||||||||||||||||
|
|
||||||||||||||||||
| The integration will automatically detect streaming vs non-streaming requests and handle them appropriately. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Supported Versions | ||||||||||||||||||
|
|
||||||||||||||||||
| - `@google/genai`: `>=0.10.0 <2` | ||||||||||||||||||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldn't this section also be visible for Next.JS? IIUC only the edge runtime needs the other setup?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not for edge runtime, we are handling this down in a <PlatformSection supported={['javascript.nextjs']}> section