v8: serverless profiling and performance

s1gr1d · s1gr1d · commit 16769dae723f · 2024-05-03T15:55:59.000+02:00
diff --git a/docs/platforms/javascript/guides/aws-lambda/performance/instrumentation/automatic-instrumentation.mdx b/docs/platforms/javascript/guides/aws-lambda/performance/instrumentation/automatic-instrumentation.mdx
@@ -4,39 +4,28 @@ description: "Learn what transactions are captured after tracing is enabled."
 sidebar_order: 10
 ---
 
-By default, Sentry's Node.js SDK can automatically instrument HTTP calls.
-In order for this to work, you have to create transactions which the HTTP calls will be added to as spans.
-
-Read more about [Custom Instrumentation](./../custom-instrumentation/) to learn how to create transactions and add your own spans.
-
-<Note>
-
-If you're adopting Performance in a high-throughput environment, we recommend testing prior to deployment to ensure that your service's performance characteristics maintain expectations.
-
-Note, that calling `Sentry.autoDiscoverNodePerformanceMonitoringIntegrations` will degrade startup performance of your app due to file I/O operations.
-This is especially a concern in Serverless functions.
-We recommend manually adding <PlatformLink to="/performance/database" >database integrations</PlatformLink> of your choice manually (see example below).
-
-</Note>
-
-<SignInNote />
+When performance is enabled through `tracesSampleRate`, `enableTracing` or a `tracesSampler` function, the Sentry SDK will automatically capture spans for the following:
+
+- Fastify routes & middlewares
+- HTTP requests made with `http`, `https` and `fetch`
+- DB queries made with:
+- `mysql`
+- `mysql2`
+- `pg`
+- `graphql` (including Apollo Server)
+- `mongo`
+- `mongoose`
+- `prisma`
+- `ioredis`
+
+All of these are automatically set up for you without any further configuration. The only exception is Prisma, which you have to opt-in for:
 
 ```javascript
-const Sentry = require("@sentry/node");
+const Sentry = require("@sentry/aws-serverless");
 
 Sentry.init({
   dsn: "___PUBLIC_DSN___",
-  integrations: [
-    // Automatically instrument Node.js libraries and frameworks
-    // (This function is slow because of file I/O, consider manually adding additional integrations instead)
-    ...Sentry.autoDiscoverNodePerformanceMonitoringIntegrations(),
-    // Or manually add integrations of your choice. For example:
-    new Sentry.Integrations.Apollo(),
-    new Sentry.Integrations.Postgres(),
-  ],
-
-  // We recommend adjusting this value in production, or using tracesSampler
-  // for finer control
   tracesSampleRate: 1.0,
+  integrations: [Sentry.prismaIntegration()],
 });
 ```
diff --git a/docs/platforms/javascript/guides/aws-lambda/profiling/index.mdx b/docs/platforms/javascript/guides/aws-lambda/profiling/index.mdx
@@ -16,26 +16,26 @@ If you're adopting Profiling in a high-throughput environment, we recommend test
 <Note>
 
 Node profiling is available starting in `@sentry/profiling-node` version `0.3.0`.
-You have to have the `@sentry/node` (minimum version `7.44.1`) package installed.
+You have to have the `@sentry/aws-serverless` (minimum version `8.0.0`) package installed.
 
 </Note>
 
 ```bash {tabTitle:npm}
-npm install --save @sentry/node @sentry/profiling-node
+npm install --save @sentry/aws-serverless @sentry/profiling-node
 ```
 
 ```bash {tabTitle:Yarn}
-yarn add @sentry/node @sentry/profiling-node
+yarn add @sentry/aws-serverless @sentry/profiling-node
 ```
 
 ## Enabling Profiling
 
-To enable profiling, import @sentry/profiling-node, add ProfilingIntegration to your integrations, and set the profilesSampleRate.
+To enable profiling, import `@sentry/profiling-node`, add the `nodeProfilingIntegration` to your integrations, and set the `profilesSampleRate`.
 
 <SignInNote />
 
 ```javascript
-const Sentry = require("@sentry/node");
+const Sentry = require("@sentry/aws-serverless");
 const { nodeProfilingIntegration } = require("@sentry/profiling-node");
 
 Sentry.init({
diff --git a/docs/platforms/javascript/guides/azure-functions/performance/instrumentation/automatic-instrumentation.mdx b/docs/platforms/javascript/guides/azure-functions/performance/instrumentation/automatic-instrumentation.mdx
@@ -4,39 +4,4 @@ description: "Learn what transactions are captured after tracing is enabled."
 sidebar_order: 10
 ---
 
-By default, Sentry's Node.js SDK can automatically instrument HTTP calls.
-In order for this to work, you have to create transactions which the HTTP calls will be added to as spans.
-
-Read more about [Custom Instrumentation](./../custom-instrumentation/) to learn how to create transactions and add your own spans.
-
-<Note>
-
-If you're adopting Performance in a high-throughput environment, we recommend testing prior to deployment to ensure that your service's performance characteristics maintain expectations.
-
-Note, that calling `Sentry.autoDiscoverNodePerformanceMonitoringIntegrations` will degrade startup performance of your app due to file I/O operations.
-This is especially a concern in Serverless functions.
-We recommend manually adding <PlatformLink to="/performance/database" >database integrations</PlatformLink> of your choice manually (see example below).
-
-</Note>
-
-<SignInNote />
-
-```javascript
-const Sentry = require("@sentry/node");
-
-Sentry.init({
-  dsn: "___PUBLIC_DSN___",
-  integrations: [
-    // Automatically instrument Node.js libraries and frameworks
-    // (This function is slow because of file I/O, consider manually adding additional integrations instead)
-    ...Sentry.autoDiscoverNodePerformanceMonitoringIntegrations(),
-    // Or manually add integrations of your choice. For example:
-    new Sentry.Integrations.Apollo(),
-    new Sentry.Integrations.Postgres(),
-  ],
-
-  // We recommend adjusting this value in production, or using tracesSampler
-  // for finer control
-  tracesSampleRate: 1.0,
-});
-```
+<Include name="node-automatic-instrumentation" />
diff --git a/docs/platforms/javascript/guides/gcp-functions/performance/instrumentation/automatic-instrumentation.mdx b/docs/platforms/javascript/guides/gcp-functions/performance/instrumentation/automatic-instrumentation.mdx
@@ -4,39 +4,28 @@ description: "Learn what transactions are captured after tracing is enabled."
 sidebar_order: 10
 ---
 
-By default, Sentry's Node.js SDK can automatically instrument HTTP calls.
-In order for this to work, you have to create transactions which the HTTP calls will be added to as spans.
-
-Read more about [Custom Instrumentation](./../custom-instrumentation/) to learn how to create transactions and add your own spans.
-
-<Note>
-
-If you're adopting Performance in a high-throughput environment, we recommend testing prior to deployment to ensure that your service's performance characteristics maintain expectations.
-
-Note, that calling `Sentry.autoDiscoverNodePerformanceMonitoringIntegrations` will degrade startup performance of your app due to file I/O operations.
-This is especially a concern in Serverless functions.
-We recommend manually adding <PlatformLink to="/performance/database" >database integrations</PlatformLink> of your choice manually (see example below).
-
-</Note>
-
-<SignInNote />
+When performance is enabled through `tracesSampleRate`, `enableTracing` or a `tracesSampler` function, the Sentry SDK will automatically capture spans for the following:
+
+- Fastify routes & middlewares
+- HTTP requests made with `http`, `https` and `fetch`
+- DB queries made with:
+- `mysql`
+- `mysql2`
+- `pg`
+- `graphql` (including Apollo Server)
+- `mongo`
+- `mongoose`
+- `prisma`
+- `ioredis`
+
+All of these are automatically set up for you without any further configuration. The only exception is Prisma, which you have to opt-in for:
 
 ```javascript
-const Sentry = require("@sentry/node");
+const Sentry = require("@sentry/google-cloud-serverless");
 
 Sentry.init({
   dsn: "___PUBLIC_DSN___",
-  integrations: [
-    // Automatically instrument Node.js libraries and frameworks
-    // (This function is slow because of file I/O, consider manually adding additional integrations instead)
-    ...Sentry.autoDiscoverNodePerformanceMonitoringIntegrations(),
-    // Or manually add integrations of your choice. For example:
-    new Sentry.Integrations.Apollo(),
-    new Sentry.Integrations.Postgres(),
-  ],
-
-  // We recommend adjusting this value in production, or using tracesSampler
-  // for finer control
   tracesSampleRate: 1.0,
+  integrations: [Sentry.prismaIntegration()],
 });
 ```
diff --git a/docs/platforms/javascript/guides/gcp-functions/profiling/index.mdx b/docs/platforms/javascript/guides/gcp-functions/profiling/index.mdx
@@ -16,26 +16,26 @@ If you're adopting Profiling in a high-throughput environment, we recommend test
 <Note>
 
 Node profiling is available starting in `@sentry/profiling-node` version `0.3.0`.
-You have to have the `@sentry/node` (minimum version `7.44.1`) package installed.
+You have to have the `@sentry/google-cloud-serverless` (minimum version `8.0.0`) package installed.
 
 </Note>
 
 ```bash {tabTitle:npm}
-npm install --save @sentry/node @sentry/profiling-node
+npm install --save @sentry/google-cloud-serverless @sentry/profiling-node
 ```
 
 ```bash {tabTitle:Yarn}
-yarn add @sentry/node @sentry/profiling-node
+yarn add @sentry/google-cloud-serverless @sentry/profiling-node
 ```
 
 ## Enabling Profiling
 
-To enable profiling, import @sentry/profiling-node, add ProfilingIntegration to your integrations, and set the profilesSampleRate.
+To enable profiling, import `@sentry/profiling-node`, add the `nodeProfilingIntegration` to your integrations, and set the `profilesSampleRate`.
 
 <SignInNote />
 
 ```javascript
-const Sentry = require("@sentry/node");
+const Sentry = require("@sentry/google-cloud-serverless");
 const { nodeProfilingIntegration } = require("@sentry/profiling-node");
 
 Sentry.init({
