diff --git a/docs/platforms/javascript/common/profiling/index.mdx b/docs/platforms/javascript/common/profiling/index.mdx index dcddf31ebdde44..6f537685998892 100644 --- a/docs/platforms/javascript/common/profiling/index.mdx +++ b/docs/platforms/javascript/common/profiling/index.mdx @@ -1,7 +1,7 @@ --- title: Set Up Profiling sidebar_order: 5000 -description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations. Get started with browser and Node.js profiling to understand your application's performance." +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations. Get started with profiling to understand your application's performance." notSupported: - javascript.bun - javascript.cordova @@ -10,4 +10,4 @@ notSupported: - javascript.cloudflare --- - \ No newline at end of file + diff --git a/docs/platforms/javascript/guides/astro/profiling/browser.mdx b/docs/platforms/javascript/guides/astro/profiling/browser.mdx new file mode 100644 index 00000000000000..014fa307a164ed --- /dev/null +++ b/docs/platforms/javascript/guides/astro/profiling/browser.mdx @@ -0,0 +1,6 @@ +--- +title: Browser Profiling +description: "Get started with Browser profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/astro/profiling/index.mdx b/docs/platforms/javascript/guides/astro/profiling/index.mdx new file mode 100644 index 00000000000000..1d95c81aaaa884 --- /dev/null +++ b/docs/platforms/javascript/guides/astro/profiling/index.mdx @@ -0,0 +1,7 @@ +--- +title: Set Up Profiling +sidebar_order: 5000 +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations." +--- + + diff --git a/docs/platforms/javascript/guides/astro/profiling/node.mdx b/docs/platforms/javascript/guides/astro/profiling/node.mdx new file mode 100644 index 00000000000000..d82c391ad5a3a1 --- /dev/null +++ b/docs/platforms/javascript/guides/astro/profiling/node.mdx @@ -0,0 +1,6 @@ +--- +title: Node Profiling +description: "Get started with Node.js profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/gatsby/profiling/browser.mdx b/docs/platforms/javascript/guides/gatsby/profiling/browser.mdx new file mode 100644 index 00000000000000..014fa307a164ed --- /dev/null +++ b/docs/platforms/javascript/guides/gatsby/profiling/browser.mdx @@ -0,0 +1,6 @@ +--- +title: Browser Profiling +description: "Get started with Browser profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/gatsby/profiling/index.mdx b/docs/platforms/javascript/guides/gatsby/profiling/index.mdx new file mode 100644 index 00000000000000..1d95c81aaaa884 --- /dev/null +++ b/docs/platforms/javascript/guides/gatsby/profiling/index.mdx @@ -0,0 +1,7 @@ +--- +title: Set Up Profiling +sidebar_order: 5000 +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations." +--- + + diff --git a/docs/platforms/javascript/guides/gatsby/profiling/node.mdx b/docs/platforms/javascript/guides/gatsby/profiling/node.mdx new file mode 100644 index 00000000000000..d82c391ad5a3a1 --- /dev/null +++ b/docs/platforms/javascript/guides/gatsby/profiling/node.mdx @@ -0,0 +1,6 @@ +--- +title: Node Profiling +description: "Get started with Node.js profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/nextjs/profiling/browser.mdx b/docs/platforms/javascript/guides/nextjs/profiling/browser.mdx new file mode 100644 index 00000000000000..014fa307a164ed --- /dev/null +++ b/docs/platforms/javascript/guides/nextjs/profiling/browser.mdx @@ -0,0 +1,6 @@ +--- +title: Browser Profiling +description: "Get started with Browser profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/nextjs/profiling/index.mdx b/docs/platforms/javascript/guides/nextjs/profiling/index.mdx new file mode 100644 index 00000000000000..1d95c81aaaa884 --- /dev/null +++ b/docs/platforms/javascript/guides/nextjs/profiling/index.mdx @@ -0,0 +1,7 @@ +--- +title: Set Up Profiling +sidebar_order: 5000 +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations." +--- + + diff --git a/docs/platforms/javascript/guides/nextjs/profiling/node.mdx b/docs/platforms/javascript/guides/nextjs/profiling/node.mdx new file mode 100644 index 00000000000000..d82c391ad5a3a1 --- /dev/null +++ b/docs/platforms/javascript/guides/nextjs/profiling/node.mdx @@ -0,0 +1,6 @@ +--- +title: Node Profiling +description: "Get started with Node.js profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/nuxt/profiling/browser.mdx b/docs/platforms/javascript/guides/nuxt/profiling/browser.mdx new file mode 100644 index 00000000000000..014fa307a164ed --- /dev/null +++ b/docs/platforms/javascript/guides/nuxt/profiling/browser.mdx @@ -0,0 +1,6 @@ +--- +title: Browser Profiling +description: "Get started with Browser profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/nuxt/profiling/index.mdx b/docs/platforms/javascript/guides/nuxt/profiling/index.mdx new file mode 100644 index 00000000000000..1d95c81aaaa884 --- /dev/null +++ b/docs/platforms/javascript/guides/nuxt/profiling/index.mdx @@ -0,0 +1,7 @@ +--- +title: Set Up Profiling +sidebar_order: 5000 +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations." +--- + + diff --git a/docs/platforms/javascript/guides/nuxt/profiling/node.mdx b/docs/platforms/javascript/guides/nuxt/profiling/node.mdx new file mode 100644 index 00000000000000..d82c391ad5a3a1 --- /dev/null +++ b/docs/platforms/javascript/guides/nuxt/profiling/node.mdx @@ -0,0 +1,6 @@ +--- +title: Node Profiling +description: "Get started with Node.js profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/react-router/profiling/browser.mdx b/docs/platforms/javascript/guides/react-router/profiling/browser.mdx new file mode 100644 index 00000000000000..014fa307a164ed --- /dev/null +++ b/docs/platforms/javascript/guides/react-router/profiling/browser.mdx @@ -0,0 +1,6 @@ +--- +title: Browser Profiling +description: "Get started with Browser profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/react-router/profiling/index.mdx b/docs/platforms/javascript/guides/react-router/profiling/index.mdx new file mode 100644 index 00000000000000..1d95c81aaaa884 --- /dev/null +++ b/docs/platforms/javascript/guides/react-router/profiling/index.mdx @@ -0,0 +1,7 @@ +--- +title: Set Up Profiling +sidebar_order: 5000 +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations." +--- + + diff --git a/docs/platforms/javascript/guides/react-router/profiling/node.mdx b/docs/platforms/javascript/guides/react-router/profiling/node.mdx new file mode 100644 index 00000000000000..d82c391ad5a3a1 --- /dev/null +++ b/docs/platforms/javascript/guides/react-router/profiling/node.mdx @@ -0,0 +1,6 @@ +--- +title: Node Profiling +description: "Get started with Node.js profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/remix/profiling/browser.mdx b/docs/platforms/javascript/guides/remix/profiling/browser.mdx new file mode 100644 index 00000000000000..014fa307a164ed --- /dev/null +++ b/docs/platforms/javascript/guides/remix/profiling/browser.mdx @@ -0,0 +1,6 @@ +--- +title: Browser Profiling +description: "Get started with Browser profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/remix/profiling/index.mdx b/docs/platforms/javascript/guides/remix/profiling/index.mdx new file mode 100644 index 00000000000000..1d95c81aaaa884 --- /dev/null +++ b/docs/platforms/javascript/guides/remix/profiling/index.mdx @@ -0,0 +1,7 @@ +--- +title: Set Up Profiling +sidebar_order: 5000 +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations." +--- + + diff --git a/docs/platforms/javascript/guides/remix/profiling/node.mdx b/docs/platforms/javascript/guides/remix/profiling/node.mdx new file mode 100644 index 00000000000000..d82c391ad5a3a1 --- /dev/null +++ b/docs/platforms/javascript/guides/remix/profiling/node.mdx @@ -0,0 +1,6 @@ +--- +title: Node Profiling +description: "Get started with Node.js profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/solidstart/profiling/browser.mdx b/docs/platforms/javascript/guides/solidstart/profiling/browser.mdx new file mode 100644 index 00000000000000..014fa307a164ed --- /dev/null +++ b/docs/platforms/javascript/guides/solidstart/profiling/browser.mdx @@ -0,0 +1,6 @@ +--- +title: Browser Profiling +description: "Get started with Browser profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/solidstart/profiling/index.mdx b/docs/platforms/javascript/guides/solidstart/profiling/index.mdx new file mode 100644 index 00000000000000..1d95c81aaaa884 --- /dev/null +++ b/docs/platforms/javascript/guides/solidstart/profiling/index.mdx @@ -0,0 +1,7 @@ +--- +title: Set Up Profiling +sidebar_order: 5000 +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations." +--- + + diff --git a/docs/platforms/javascript/guides/solidstart/profiling/node.mdx b/docs/platforms/javascript/guides/solidstart/profiling/node.mdx new file mode 100644 index 00000000000000..d82c391ad5a3a1 --- /dev/null +++ b/docs/platforms/javascript/guides/solidstart/profiling/node.mdx @@ -0,0 +1,6 @@ +--- +title: Node Profiling +description: "Get started with Node.js profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/sveltekit/profiling/browser.mdx b/docs/platforms/javascript/guides/sveltekit/profiling/browser.mdx new file mode 100644 index 00000000000000..014fa307a164ed --- /dev/null +++ b/docs/platforms/javascript/guides/sveltekit/profiling/browser.mdx @@ -0,0 +1,6 @@ +--- +title: Browser Profiling +description: "Get started with Browser profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/sveltekit/profiling/index.mdx b/docs/platforms/javascript/guides/sveltekit/profiling/index.mdx new file mode 100644 index 00000000000000..1d95c81aaaa884 --- /dev/null +++ b/docs/platforms/javascript/guides/sveltekit/profiling/index.mdx @@ -0,0 +1,7 @@ +--- +title: Set Up Profiling +sidebar_order: 5000 +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations." +--- + + diff --git a/docs/platforms/javascript/guides/sveltekit/profiling/node.mdx b/docs/platforms/javascript/guides/sveltekit/profiling/node.mdx new file mode 100644 index 00000000000000..d82c391ad5a3a1 --- /dev/null +++ b/docs/platforms/javascript/guides/sveltekit/profiling/node.mdx @@ -0,0 +1,6 @@ +--- +title: Node Profiling +description: "Get started with Node.js profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/tanstackstart-react/profiling/browser.mdx b/docs/platforms/javascript/guides/tanstackstart-react/profiling/browser.mdx new file mode 100644 index 00000000000000..014fa307a164ed --- /dev/null +++ b/docs/platforms/javascript/guides/tanstackstart-react/profiling/browser.mdx @@ -0,0 +1,6 @@ +--- +title: Browser Profiling +description: "Get started with Browser profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/guides/tanstackstart-react/profiling/index.mdx b/docs/platforms/javascript/guides/tanstackstart-react/profiling/index.mdx new file mode 100644 index 00000000000000..1d95c81aaaa884 --- /dev/null +++ b/docs/platforms/javascript/guides/tanstackstart-react/profiling/index.mdx @@ -0,0 +1,7 @@ +--- +title: Set Up Profiling +sidebar_order: 5000 +description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations." +--- + + diff --git a/docs/platforms/javascript/guides/tanstackstart-react/profiling/node.mdx b/docs/platforms/javascript/guides/tanstackstart-react/profiling/node.mdx new file mode 100644 index 00000000000000..d82c391ad5a3a1 --- /dev/null +++ b/docs/platforms/javascript/guides/tanstackstart-react/profiling/node.mdx @@ -0,0 +1,6 @@ +--- +title: Node Profiling +description: "Get started with Node.js profiling to understand your application's performance." +--- + + diff --git a/docs/platforms/javascript/common/profiling/browser-profiling.mdx b/platform-includes/profiling/browser-profiling/javascript.mdx similarity index 85% rename from docs/platforms/javascript/common/profiling/browser-profiling.mdx rename to platform-includes/profiling/browser-profiling/javascript.mdx index 964dc7ad7ac2b8..64ed5a4800c8ce 100644 --- a/docs/platforms/javascript/common/profiling/browser-profiling.mdx +++ b/platform-includes/profiling/browser-profiling/javascript.mdx @@ -1,28 +1,3 @@ ---- -title: Browser Profiling -sidebar_order: 5000 -supported: - - javascript -notSupported: - - javascript.bun - - javascript.cordova - - javascript.capacitor - - javascript.deno - - javascript.cloudflare - - 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 -description: "Collect & view performance insights for JavaScript programs with Sentry's JavaScript Profiling integration." ---- - Browser Profiling is currently in beta. Beta features are still in progress and may have bugs. We recognize the irony. diff --git a/platform-includes/profiling/landing-page/javascript.mdx b/platform-includes/profiling/landing-page/javascript.mdx new file mode 100644 index 00000000000000..2f947ae78060ec --- /dev/null +++ b/platform-includes/profiling/landing-page/javascript.mdx @@ -0,0 +1 @@ + diff --git a/platform-includes/profiling/landing-page/javascript.node.mdx b/platform-includes/profiling/landing-page/javascript.node.mdx new file mode 100644 index 00000000000000..b8f68a7c591a81 --- /dev/null +++ b/platform-includes/profiling/landing-page/javascript.node.mdx @@ -0,0 +1 @@ + diff --git a/docs/platforms/javascript/common/profiling/node-profiling.mdx b/platform-includes/profiling/node-profiling/javascript.mdx similarity index 86% rename from docs/platforms/javascript/common/profiling/node-profiling.mdx rename to platform-includes/profiling/node-profiling/javascript.mdx index bd83ffb383fb00..4a36a330a9112e 100644 --- a/docs/platforms/javascript/common/profiling/node-profiling.mdx +++ b/platform-includes/profiling/node-profiling/javascript.mdx @@ -1,26 +1,3 @@ ---- -title: Node Profiling -sidebar_order: 5000 -description: "Learn more about how to configure our Profiling integration and start profiling your code." -supported: - - javascript.nextjs - - javascript.sveltekit - - javascript.remix - - javascript.astro - - 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.tanstackstart-react ---- - By default, Sentry error events will not get trace context unless you configure the scope with the transaction, as illustrated in the example below. @@ -31,8 +8,21 @@ If you're adopting Profiling in a high-throughput environment, we recommend test ## Installation -Node profiling is available starting in `@sentry/profiling-node` version `0.3.0`. -You have to have the (minimum version `7.44.1`) package installed. +You have to install the `@sentry/profiling-node` package in addition to your main SDK package: + +```bash {tabTitle:npm} +npm install @sentry/profiling-node --save +``` + +```bash {tabTitle:yarn} +yarn add @sentry/profiling-node +``` + +```bash {tabTitle:pnpm} +pnpm add @sentry/profiling-node +``` + +The version of the `@sentry/profiling-node` package must match the version of the main SDK package exactly. ## Enabling Profiling diff --git a/redirects.js b/redirects.js index 2279020f01d1bd..3313748c723984 100644 --- a/redirects.js +++ b/redirects.js @@ -1057,7 +1057,7 @@ const userDocsRedirects = [ destination: '/platforms/javascript/tracing/distributed-tracing/:path*', }, { - source: '/platforms/javascript//tracing/instrumentation/performance-metrics/', + source: '/platforms/javascript/tracing/instrumentation/performance-metrics/', destination: '/platforms/javascript/tracing/span-metrics/', }, { @@ -1070,6 +1070,22 @@ const userDocsRedirects = [ '/platforms/javascript//tracing/instrumentation/span-metrics/performance-metrics/', destination: '/platforms/javascript/tracing/span-metrics/', }, + { + source: '/platforms/javascript/profiling/browser-profiling/', + destination: '/platforms/javascript/profiling/', + }, + { + source: '/platforms/javascript/guides/:guide/profiling/browser-profiling/', + destination: '/platforms/javascript/guides/:guide/profiling/', + }, + { + source: '/platforms/javascript/guides/:guide/profiling/node-profiling/', + destination: '/platforms/javascript/guides/:guide/profiling/', + }, + { + source: '/platforms/javascript/guides/:guide/profiling/browser-profiling/', + destination: '/platforms/javascript/guides/:guide/profiling/', + }, { source: '/platforms/javascript/guides/:guide/tracing/span-metrics/performance-metrics/',