From 2f1345cfa841e5bc5eac8ee1646ca18ac9bf5b7e Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Mon, 26 Aug 2024 15:46:34 +0200 Subject: [PATCH 1/3] [JS SDK] Add docs for `fsIntegration` --- .../common/configuration/integrations/fs.mdx | 55 +++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 docs/platforms/javascript/common/configuration/integrations/fs.mdx diff --git a/docs/platforms/javascript/common/configuration/integrations/fs.mdx b/docs/platforms/javascript/common/configuration/integrations/fs.mdx new file mode 100644 index 0000000000000..162aead01e863 --- /dev/null +++ b/docs/platforms/javascript/common/configuration/integrations/fs.mdx @@ -0,0 +1,55 @@ +--- +title: FileSystem +description: "Adds instrumentation for filesystem operations." +supported: + - javascript.node + - javascript.aws-lambda + - javascript.azure-functions + - javascript.connect + - javascript.express + - javascript.fastify + - javascript.gcp-functions + - javascript.hapi + - javascript.koa + - javascript.nestjs + - javascript.electron + - javascript.nextjs + - javascript.nuxt + - javascript.sveltekit + - javascript.remix + - javascript.astro + - javascript.bun +--- + + + +This integration only works in the Node.js and Bun runtimes. + + + +_Import name: `Sentry.fsIntegration`_ + +The `fsIntegration` will create spans for `fs` API operations, like reading and writing files. The integration uses the [`@opentelemetry/instrumentation-fs`](https://www.npmjs.com/package/@opentelemetry/instrumentation-fs) package. + + + The `fsIntegration` may add significant overhead to your application. + Especially in scenarios with a lot of file I/O, like for example when you are + running a framework dev server, including this integration can massively slow + down your application. + + +## Options + +### `recordFilePaths` + +_Type: `boolean | undefined`_ + +Setting this option to `true` will include any filepath arguments from your `fs` API calls as span attributes. +Defaults to `false`. + +### `recordErrorMessagesAsSpanAttributes` + +_Type: `boolean | undefined`_ + +Setting this option to `true` will include the error messages of failed `fs` API calls as a span attribute. +Defaults to `false`. From 24da3b88822852d9837a8485d8a65fe2b4a11c46 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Tue, 27 Aug 2024 11:10:32 +0200 Subject: [PATCH 2/3] Update docs/platforms/javascript/common/configuration/integrations/fs.mdx Co-authored-by: Lukas Stracke --- .../javascript/common/configuration/integrations/fs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/javascript/common/configuration/integrations/fs.mdx b/docs/platforms/javascript/common/configuration/integrations/fs.mdx index 162aead01e863..092652a6ad5e9 100644 --- a/docs/platforms/javascript/common/configuration/integrations/fs.mdx +++ b/docs/platforms/javascript/common/configuration/integrations/fs.mdx @@ -29,7 +29,7 @@ This integration only works in the Node.js and Bun runtimes. _Import name: `Sentry.fsIntegration`_ -The `fsIntegration` will create spans for `fs` API operations, like reading and writing files. The integration uses the [`@opentelemetry/instrumentation-fs`](https://www.npmjs.com/package/@opentelemetry/instrumentation-fs) package. +The `fsIntegration` creates spans for `fs` API operations, like reading and writing files. The integration uses the [`@opentelemetry/instrumentation-fs`](https://www.npmjs.com/package/@opentelemetry/instrumentation-fs) package. The `fsIntegration` may add significant overhead to your application. From cede921ce0f655da36e9a7fad164746215e59f38 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Tue, 27 Aug 2024 11:15:28 +0200 Subject: [PATCH 3/3] Add to overview tables --- .../configuration/integrations/javascript.astro.mdx | 1 + .../configuration/integrations/javascript.aws-lambda.mdx | 1 + platform-includes/configuration/integrations/javascript.bun.mdx | 1 + .../configuration/integrations/javascript.fastify.mdx | 1 + .../configuration/integrations/javascript.gcp-functions.mdx | 1 + .../configuration/integrations/javascript.nestjs.mdx | 1 + .../configuration/integrations/javascript.nextjs.mdx | 1 + platform-includes/configuration/integrations/javascript.node.mdx | 1 + platform-includes/configuration/integrations/javascript.nuxt.mdx | 1 + .../configuration/integrations/javascript.remix.mdx | 1 + .../configuration/integrations/javascript.sveltekit.mdx | 1 + 11 files changed, 11 insertions(+) diff --git a/platform-includes/configuration/integrations/javascript.astro.mdx b/platform-includes/configuration/integrations/javascript.astro.mdx index 3fdaa2b50cb9e..371820d4c923f 100644 --- a/platform-includes/configuration/integrations/javascript.astro.mdx +++ b/platform-includes/configuration/integrations/javascript.astro.mdx @@ -61,4 +61,5 @@ Depending on whether an integration enhances the functionality of a particular r | [`anrIntegration`](./anr) | | ✓ | | | | [`localVariablesIntegration`](./localvariables) | | ✓ | | | | [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | diff --git a/platform-includes/configuration/integrations/javascript.aws-lambda.mdx b/platform-includes/configuration/integrations/javascript.aws-lambda.mdx index 4eff803d43b41..64cfd0b560086 100644 --- a/platform-includes/configuration/integrations/javascript.aws-lambda.mdx +++ b/platform-includes/configuration/integrations/javascript.aws-lambda.mdx @@ -33,4 +33,5 @@ | [`requestDataIntegration`](./requestdata) | | | ✓ | | | [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | | [`sessionTimingIntegration`](./sessiontiming) | | | | ✓ | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | diff --git a/platform-includes/configuration/integrations/javascript.bun.mdx b/platform-includes/configuration/integrations/javascript.bun.mdx index f400e3b7d7fca..911aeab271a63 100644 --- a/platform-includes/configuration/integrations/javascript.bun.mdx +++ b/platform-includes/configuration/integrations/javascript.bun.mdx @@ -29,4 +29,5 @@ | [`extraErrorDataIntegration`](./extraerrordata) | | | | ✓ | | [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | | [`sessionTimingIntegration`](./sessiontiming) | | | | ✓ | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | diff --git a/platform-includes/configuration/integrations/javascript.fastify.mdx b/platform-includes/configuration/integrations/javascript.fastify.mdx index 13cd53913221d..41119f6aee48f 100644 --- a/platform-includes/configuration/integrations/javascript.fastify.mdx +++ b/platform-includes/configuration/integrations/javascript.fastify.mdx @@ -30,4 +30,5 @@ | [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | | | [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | | [`sessionTimingIntegration`](./sessiontiming) | | | | ✓ | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | diff --git a/platform-includes/configuration/integrations/javascript.gcp-functions.mdx b/platform-includes/configuration/integrations/javascript.gcp-functions.mdx index 9f6a107921a01..1739fd983eb27 100644 --- a/platform-includes/configuration/integrations/javascript.gcp-functions.mdx +++ b/platform-includes/configuration/integrations/javascript.gcp-functions.mdx @@ -33,4 +33,5 @@ | [`requestDataIntegration`](./requestdata) | | | ✓ | | | [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | | [`sessionTimingIntegration`](./sessiontiming) | | | | ✓ | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | diff --git a/platform-includes/configuration/integrations/javascript.nestjs.mdx b/platform-includes/configuration/integrations/javascript.nestjs.mdx index 9d77b34fc2da0..383a243faa291 100644 --- a/platform-includes/configuration/integrations/javascript.nestjs.mdx +++ b/platform-includes/configuration/integrations/javascript.nestjs.mdx @@ -31,4 +31,5 @@ | [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | | | [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | | [`sessionTimingIntegration`](./sessiontiming) | | | | ✓ | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | diff --git a/platform-includes/configuration/integrations/javascript.nextjs.mdx b/platform-includes/configuration/integrations/javascript.nextjs.mdx index a467f0da84316..83bd9b7202c83 100644 --- a/platform-includes/configuration/integrations/javascript.nextjs.mdx +++ b/platform-includes/configuration/integrations/javascript.nextjs.mdx @@ -67,6 +67,7 @@ Depending on whether an integration enhances the functionality of a particular r | [`anrIntegration`](./anr) | | ✓ | | | | [`localVariablesIntegration`](./localvariables) | | ✓ | | | | [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | ### Edge Integrations diff --git a/platform-includes/configuration/integrations/javascript.node.mdx b/platform-includes/configuration/integrations/javascript.node.mdx index 9d77b34fc2da0..383a243faa291 100644 --- a/platform-includes/configuration/integrations/javascript.node.mdx +++ b/platform-includes/configuration/integrations/javascript.node.mdx @@ -31,4 +31,5 @@ | [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | | | [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | | [`sessionTimingIntegration`](./sessiontiming) | | | | ✓ | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | diff --git a/platform-includes/configuration/integrations/javascript.nuxt.mdx b/platform-includes/configuration/integrations/javascript.nuxt.mdx index 0a07fbc21519a..e13c715497e3f 100644 --- a/platform-includes/configuration/integrations/javascript.nuxt.mdx +++ b/platform-includes/configuration/integrations/javascript.nuxt.mdx @@ -61,4 +61,5 @@ Depending on whether an integration enhances the functionality of a particular r | [`anrIntegration`](./anr) | | ✓ | | | | [`localVariablesIntegration`](./localvariables) | | ✓ | | | | [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | diff --git a/platform-includes/configuration/integrations/javascript.remix.mdx b/platform-includes/configuration/integrations/javascript.remix.mdx index 0c963275a014b..fc3b337f309d9 100644 --- a/platform-includes/configuration/integrations/javascript.remix.mdx +++ b/platform-includes/configuration/integrations/javascript.remix.mdx @@ -61,4 +61,5 @@ Depending on whether an integration enhances the functionality of a particular r | [`anrIntegration`](./anr) | | ✓ | | | | [`localVariablesIntegration`](./localvariables) | | ✓ | | | | [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | diff --git a/platform-includes/configuration/integrations/javascript.sveltekit.mdx b/platform-includes/configuration/integrations/javascript.sveltekit.mdx index df04b4094c098..1f43774a212f6 100644 --- a/platform-includes/configuration/integrations/javascript.sveltekit.mdx +++ b/platform-includes/configuration/integrations/javascript.sveltekit.mdx @@ -61,4 +61,5 @@ Depending on whether an integration enhances the functionality of a particular r | [`anrIntegration`](./anr) | | ✓ | | | | [`localVariablesIntegration`](./localvariables) | | ✓ | | | | [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | | +| [`fsIntegration`](./fs) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |