Merge branch 'develop' into feat/growthbook-integration

Author: madhuchavva

dev-packages/node-integration-tests/suites/tracing/anthropic/scenario.mjs

@@ -29,6 +29,55 @@ function startMockAnthropicServer() {
       return;
     }
 
+    // Check if streaming is requested
+    if (req.body.stream === true) {
+      res.writeHead(200, {
+        'Content-Type': 'text/event-stream',
+        'Cache-Control': 'no-cache',
+        Connection: 'keep-alive',
+      });
+
+      // Send streaming events
+      const events = [
+        {
+          type: 'message_start',
+          message: {
+            id: 'msg_stream123',
+            type: 'message',
+            role: 'assistant',
+            model,
+            content: [],
+            usage: { input_tokens: 10 },
+          },
+        },
+        { type: 'content_block_start', index: 0, content_block: { type: 'text', text: '' } },
+        { type: 'content_block_delta', index: 0, delta: { type: 'text_delta', text: 'Hello ' } },
+        { type: 'content_block_delta', index: 0, delta: { type: 'text_delta', text: 'from ' } },
+        { type: 'content_block_delta', index: 0, delta: { type: 'text_delta', text: 'stream!' } },
+        { type: 'content_block_stop', index: 0 },
+        {
+          type: 'message_delta',
+          delta: { stop_reason: 'end_turn', stop_sequence: null },
+          usage: { output_tokens: 15 },
+        },
+        { type: 'message_stop' },
+      ];
+
+      events.forEach((event, index) => {
+        setTimeout(() => {
+          res.write(`event: ${event.type}\n`);
+          res.write(`data: ${JSON.stringify(event)}\n\n`);
+
+          if (index === events.length - 1) {
+            res.end();
+          }
+        }, index * 10); // Small delay between events
+      });
+
+      return;
+    }
+
+    // Non-streaming response
     res.send({
       id: 'msg_mock123',
       type: 'message',
@@ -92,8 +141,32 @@ async function run() {
 
     // Fourth test: models.retrieve
     await client.models.retrieve('claude-3-haiku-20240307');
+
+    // Fifth test: streaming via messages.create
+    const stream = await client.messages.create({
+      model: 'claude-3-haiku-20240307',
+      messages: [{ role: 'user', content: 'What is the capital of France?' }],
+      stream: true,
+    });
+
+    for await (const _ of stream) {
+      void _;
+    }
+
+    // Sixth test: streaming via messages.stream
+    await client.messages
+      .stream({
+        model: 'claude-3-haiku-20240307',
+        messages: [{ role: 'user', content: 'What is the capital of France?' }],
+      })
+      .on('streamEvent', () => {
+        Sentry.captureMessage('stream event from user-added event listener captured');
+      });
   });
 
+  // Wait for the stream event handler to finish
+  await Sentry.flush(2000);
+
   server.close();
 }
 

dev-packages/node-integration-tests/suites/tracing/anthropic/test.ts

@@ -152,6 +152,30 @@ describe('Anthropic integration', () => {
         origin: 'auto.ai.anthropic',
         status: 'ok',
       }),
+      // Fifth span - messages.create with stream: true
+      expect.objectContaining({
+        data: expect.objectContaining({
+          'gen_ai.operation.name': 'messages',
+          'gen_ai.request.model': 'claude-3-haiku-20240307',
+          'gen_ai.request.stream': true,
+        }),
+        description: 'messages claude-3-haiku-20240307 stream-response',
+        op: 'gen_ai.messages',
+        origin: 'auto.ai.anthropic',
+        status: 'ok',
+      }),
+      // Sixth span - messages.stream
+      expect.objectContaining({
+        data: expect.objectContaining({
+          'gen_ai.operation.name': 'messages',
+          'gen_ai.request.model': 'claude-3-haiku-20240307',
+          'gen_ai.request.stream': true,
+        }),
+        description: 'messages claude-3-haiku-20240307 stream-response',
+        op: 'gen_ai.messages',
+        origin: 'auto.ai.anthropic',
+        status: 'ok',
+      }),
     ]),
   };
 
@@ -189,6 +213,21 @@ describe('Anthropic integration', () => {
     ]),
   };
 
+  const EXPECTED_MODEL_ERROR = {
+    exception: {
+      values: [
+        {
+          type: 'Error',
+          value: '404 Model not found',
+        },
+      ],
+    },
+  };
+
+  const EXPECTED_STREAM_EVENT_HANDLER_MESSAGE = {
+    message: 'stream event from user-added event listener captured',
+  };
+
   createEsmAndCjsTests(__dirname, 'scenario-manual-client.mjs', 'instrument.mjs', (createRunner, test) => {
     test('creates anthropic related spans when manually insturmenting client', async () => {
       await createRunner()
@@ -202,8 +241,9 @@ describe('Anthropic integration', () => {
   createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
     test('creates anthropic related spans with sendDefaultPii: false', async () => {
       await createRunner()
-        .ignore('event')
+        .expect({ event: EXPECTED_MODEL_ERROR })
         .expect({ transaction: EXPECTED_TRANSACTION_DEFAULT_PII_FALSE })
+        .expect({ event: EXPECTED_STREAM_EVENT_HANDLER_MESSAGE })
         .start()
         .completed();
     });
@@ -212,8 +252,9 @@ describe('Anthropic integration', () => {
   createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument-with-pii.mjs', (createRunner, test) => {
     test('creates anthropic related spans with sendDefaultPii: true', async () => {
       await createRunner()
-        .ignore('event')
+        .expect({ event: EXPECTED_MODEL_ERROR })
         .expect({ transaction: EXPECTED_TRANSACTION_DEFAULT_PII_TRUE })
+        .expect({ event: EXPECTED_STREAM_EVENT_HANDLER_MESSAGE })
         .start()
         .completed();
     });
@@ -222,8 +263,9 @@ describe('Anthropic integration', () => {
   createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument-with-options.mjs', (createRunner, test) => {
     test('creates anthropic related spans with custom options', async () => {
       await createRunner()
-        .ignore('event')
+        .expect({ event: EXPECTED_MODEL_ERROR })
         .expect({ transaction: EXPECTED_TRANSACTION_WITH_OPTIONS })
+        .expect({ event: EXPECTED_STREAM_EVENT_HANDLER_MESSAGE })
         .start()
         .completed();
     });

packages/aws-serverless/README.md

@@ -15,16 +15,53 @@
 This package is a wrapper around `@sentry/node`, with added functionality related to AWS Lambda. All
 methods available in `@sentry/node` can be imported from `@sentry/aws-serverless`.
 
-To use this SDK, call `Sentry.init(options)` at the very beginning of your JavaScript file.
+### Automatic Setup
+
+To use this SDK with an automatic setup, set the following environment variables in your Lambda function configuration:
+
+```bash
+NODE_OPTIONS="--import @sentry/aws-serverless/awslambda-auto"
+SENTRY_DSN="__DSN__"
+# Add Tracing by setting tracesSampleRate and adding integration
+# Set tracesSampleRate to 1.0 to capture 100% of transactions
+# We recommend adjusting this value in production
+# Learn more at
+# https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
+SENTRY_TRACES_SAMPLE_RATE="1.0"
+```
+
+### Manual Setup
+
+Alternatively, to further customize the SDK setup, you can also manually initialize the SDK in your lambda function. The benefit of this installation method is that you can fully customize your Sentry SDK setup in a Sentry.init call.
 
-```javascript
+Create a new file, for example `instrument.js` to initialize the SDK:
+
+```js
 import * as Sentry from '@sentry/aws-serverless';
 
 Sentry.init({
   dsn: '__DSN__',
-  // ...
+  // Adds request headers and IP for users, for more info visit:
+  // https://docs.sentry.io/platforms/javascript/guides/aws-lambda/configuration/options/#sendDefaultPii
+  sendDefaultPii: true,
+  // Add Tracing by setting tracesSampleRate and adding integration
+  // Set tracesSampleRate to 1.0 to capture 100% of transactions
+  // We recommend adjusting this value in production
+  // Learn more at
+  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
+  tracesSampleRate: 1.0,
 });
+```
+
+And then load the SDK before your function starts by importing the instrument.js file via a NODE_OPTIONS environment variable:
+
+```bash
+NODE_OPTIONS="--import ./instrument.js"
+```
+
+## Verify
 
+```js
 // async (recommended)
 export const handler = async (event, context) => {
   throw new Error('oh, hello there!');
@@ -36,19 +73,7 @@ export const handler = (event, context, callback) => {
 };
 ```
 
-If you also want to trace performance of all the incoming requests and also outgoing AWS service requests, just set the
-`tracesSampleRate` option.
-
-```javascript
-import * as Sentry from '@sentry/aws-serverless';
-
-Sentry.init({
-  dsn: '__DSN__',
-  tracesSampleRate: 1.0,
-});
-```
-
-#### Integrate Sentry using the Sentry Lambda layer
+## Integrate Sentry using the Sentry Lambda layer
 
 Another much simpler way to integrate Sentry to your AWS Lambda function is to add the official layer.
 

packages/aws-serverless/package.json

@@ -79,7 +79,7 @@
   },
   "scripts": {
     "build": "run-p build:transpile build:types",
-    "build:layer": "rollup -c rollup.lambda-extension.config.mjs && yarn ts-node scripts/buildLambdaLayer.ts",
+    "build:layer": "rimraf build/aws && rollup -c rollup.lambda-extension.config.mjs && yarn ts-node scripts/buildLambdaLayer.ts",
     "build:dev": "run-p build:transpile build:types",
     "build:transpile": "rollup -c rollup.npm.config.mjs && yarn build:layer",
     "build:types": "run-s build:types:core build:types:downlevel",

packages/aws-serverless/scripts/buildLambdaLayer.ts

@@ -51,9 +51,11 @@ async function buildLambdaLayer(): Promise<void> {
   fs.chmodSync('./build/aws/dist-serverless/sentry-extension/index.mjs', 0o755);
 
   const zipFilename = `sentry-node-serverless-${version}.zip`;
+  // Only include these directories in the zip file
+  const dirsToZip = ['nodejs', 'extensions', 'sentry-extension'];
   console.log(`Creating final layer zip file ${zipFilename}.`);
   // need to preserve the symlink above with -y
-  run(`zip -r -y ${zipFilename} .`, { cwd: 'build/aws/dist-serverless' });
+  run(`zip -r -y ${zipFilename} ${dirsToZip.join(' ')}`, { cwd: 'build/aws/dist-serverless' });
 }
 
 // eslint-disable-next-line @typescript-eslint/no-floating-promises
@@ -79,7 +81,11 @@ async function pruneNodeModules(): Promise<void> {
     './build/aws/dist-serverless/nodejs/node_modules/@sentry/aws-serverless/build/npm/esm/awslambda-auto.js',
   ];
 
-  const { fileList } = await nodeFileTrace(entrypoints);
+  const { fileList } = await nodeFileTrace(entrypoints, {
+    // import-in-the-middle uses mixed require and import syntax in their `hook.mjs` file.
+    // So we need to set `mixedModules` to `true` to ensure that all modules are tracked.
+    mixedModules: true,
+  });
 
   const allFiles = getAllFiles('./build/aws/dist-serverless/nodejs/node_modules');