feat(tanstackstart-react): Add file exclude to configure middleware auto-instrumentation

[nicohrubec]

Depends on (i.e. do not review until the following PR is merged): #19001

This PR extends the autoInstrumentMiddleware option to support fine-grained control over which files are auto-instrumented. Previously, this option only supported a boolean setting. Now you can pass an object with an exclude array to selectively skip specific files from auto-instrumentation.

// vite.config.ts import { sentryTanstackStart } from '@sentry/tanstackstart-react'; export default defineConfig({ plugins: [ sentryTanstackStart({ autoInstrumentMiddleware: { exclude: [ /\.test\.tsx?$/, // Skip test files ], }, }), ], }); 

I also tightened the auto-instrumented file extension to only typescript files. Tanstack start recommends to use Typescript anyways so this should cover most user applications and including js files leads to tempering with post-transpiled files, which I don't really like. This way we patch the original source and that's it.

Closes#18985

[github-actions]

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario	Requests/s	% of Baseline	Prev. Requests/s	Change %
GET Baseline	8,850	-	9,086	-3%
GET With Sentry	1,709	19%	1,653	+3%
GET With Sentry (error only)	5,968	67%	6,094	-2%
POST Baseline	1,168	-	1,166	+0%
POST With Sentry	575	49%	539	+7%
POST With Sentry (error only)	1,034	89%	1,027	+1%
MYSQL Baseline	3,316	-	3,282	+1%
MYSQL With Sentry	426	13%	393	+8%
MYSQL With Sentry (error only)	2,688	81%	2,680	+0%

View base workflow run

[github-actions]

Codecov Results 📊

---

Generated by Codecov Action

[nicohrubec]

This was an unnecessary option since we just don't add this plugin if it's not enabled, so I removed it

[JPeer264]

l: This was here before - still, maybe it makes more sense to have a path.extname(id) instead and check against this, it might be faster than regex or simply an endsWith (might be more effort, since this one only takes a string)

[JPeer264]

l: I think this should be rather debug.log, where debug comes from @sentry/core

[nicohrubec]

I think this needs to be console.log since it happens during build not runtime

[cursor]

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

[s1gr1d]

Maybe it would make sense to add some defaults here. E.g. excluding the test files if this is a very common usecase

[nicohrubec]

I'll think about this some more and maybe do a follow up, for the test files for instance I think the better approach for us would be to add this to the skipped file extensions early return instead of using this option

[nicohrubec]

Update: So the current state is what I would like this to look like, meaning only patching the original source files so users can reasonably exclude certain files. However, for some reason excluding js files from the transformations results in a slight regression where auto-instrumentation for non-global function middleware is not working anymore. I haven't found an idea yet that would make this work for function middleware. So thinking about closing this. If users want to opt-out they still can be simply disabling middleware auto-instrumentation fully.

[nicohrubec]

Depends on (i.e. do not review until the following PR is merged): #19001

This PR extends the autoInstrumentMiddleware option to support fine-grained control over which files are auto-instrumented. Previously, this option only supported a boolean setting. Now you can pass an object with an exclude array to selectively skip specific files from auto-instrumentation.

// vite.config.ts import { sentryTanstackStart } from '@sentry/tanstackstart-react'; export default defineConfig({ plugins: [ sentryTanstackStart({ autoInstrumentMiddleware: { exclude: [ /\.test\.tsx?$/, // Skip test files ], }, }), ], }); 

I also tightened the auto-instrumented file extension to only typescript files. Tanstack start recommends to use Typescript anyways so this should cover most user applications and including js files leads to tempering with post-transpiled files, which I don't really like. This way we patch the original source and that's it.

Closes#18985

[github-actions]

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario	Requests/s	% of Baseline	Prev. Requests/s	Change %
GET Baseline	8,850	-	9,086	-3%
GET With Sentry	1,709	19%	1,653	+3%
GET With Sentry (error only)	5,968	67%	6,094	-2%
POST Baseline	1,168	-	1,166	+0%
POST With Sentry	575	49%	539	+7%
POST With Sentry (error only)	1,034	89%	1,027	+1%
MYSQL Baseline	3,316	-	3,282	+1%
MYSQL With Sentry	426	13%	393	+8%
MYSQL With Sentry (error only)	2,688	81%	2,680	+0%

View base workflow run

[github-actions]

Codecov Results 📊

---

Generated by Codecov Action

[nicohrubec]

This was an unnecessary option since we just don't add this plugin if it's not enabled, so I removed it

[JPeer264]

l: This was here before - still, maybe it makes more sense to have a path.extname(id) instead and check against this, it might be faster than regex or simply an endsWith (might be more effort, since this one only takes a string)

[JPeer264]

l: I think this should be rather debug.log, where debug comes from @sentry/core

[nicohrubec]

I think this needs to be console.log since it happens during build not runtime

[cursor]

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

[s1gr1d]

Maybe it would make sense to add some defaults here. E.g. excluding the test files if this is a very common usecase

[nicohrubec]

I'll think about this some more and maybe do a follow up, for the test files for instance I think the better approach for us would be to add this to the skipped file extensions early return instead of using this option

[nicohrubec]

Update: So the current state is what I would like this to look like, meaning only patching the original source files so users can reasonably exclude certain files. However, for some reason excluding js files from the transformations results in a slight regression where auto-instrumentation for non-global function middleware is not working anymore. I haven't found an idea yet that would make this work for function middleware. So thinking about closing this. If users want to opt-out they still can be simply disabling middleware auto-instrumentation fully.

[nicohrubec]

Depends on (i.e. do not review until the following PR is merged): #19001

This PR extends the autoInstrumentMiddleware option to support fine-grained control over which files are auto-instrumented. Previously, this option only supported a boolean setting. Now you can pass an object with an exclude array to selectively skip specific files from auto-instrumentation.

// vite.config.ts import { sentryTanstackStart } from '@sentry/tanstackstart-react'; export default defineConfig({ plugins: [ sentryTanstackStart({ autoInstrumentMiddleware: { exclude: [ /\.test\.tsx?$/, // Skip test files ], }, }), ], }); 

I also tightened the auto-instrumented file extension to only typescript files. Tanstack start recommends to use Typescript anyways so this should cover most user applications and including js files leads to tempering with post-transpiled files, which I don't really like. This way we patch the original source and that's it.

Closes#18985

[github-actions]

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario	Requests/s	% of Baseline	Prev. Requests/s	Change %
GET Baseline	8,850	-	9,086	-3%
GET With Sentry	1,709	19%	1,653	+3%
GET With Sentry (error only)	5,968	67%	6,094	-2%
POST Baseline	1,168	-	1,166	+0%
POST With Sentry	575	49%	539	+7%
POST With Sentry (error only)	1,034	89%	1,027	+1%
MYSQL Baseline	3,316	-	3,282	+1%
MYSQL With Sentry	426	13%	393	+8%
MYSQL With Sentry (error only)	2,688	81%	2,680	+0%

View base workflow run

[github-actions]

Codecov Results 📊

---

Generated by Codecov Action

[nicohrubec]

This was an unnecessary option since we just don't add this plugin if it's not enabled, so I removed it

[JPeer264]

l: This was here before - still, maybe it makes more sense to have a path.extname(id) instead and check against this, it might be faster than regex or simply an endsWith (might be more effort, since this one only takes a string)

[JPeer264]

l: I think this should be rather debug.log, where debug comes from @sentry/core

[nicohrubec]

I think this needs to be console.log since it happens during build not runtime

[cursor]

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

[s1gr1d]

Maybe it would make sense to add some defaults here. E.g. excluding the test files if this is a very common usecase

[nicohrubec]

I'll think about this some more and maybe do a follow up, for the test files for instance I think the better approach for us would be to add this to the skipped file extensions early return instead of using this option

[nicohrubec]

Update: So the current state is what I would like this to look like, meaning only patching the original source files so users can reasonably exclude certain files. However, for some reason excluding js files from the transformations results in a slight regression where auto-instrumentation for non-global function middleware is not working anymore. I haven't found an idea yet that would make this work for function middleware. So thinking about closing this. If users want to opt-out they still can be simply disabling middleware auto-instrumentation fully.

[nicohrubec]

Depends on (i.e. do not review until the following PR is merged): #19001

This PR extends the autoInstrumentMiddleware option to support fine-grained control over which files are auto-instrumented. Previously, this option only supported a boolean setting. Now you can pass an object with an exclude array to selectively skip specific files from auto-instrumentation.

// vite.config.ts import { sentryTanstackStart } from '@sentry/tanstackstart-react'; export default defineConfig({ plugins: [ sentryTanstackStart({ autoInstrumentMiddleware: { exclude: [ /\.test\.tsx?$/, // Skip test files ], }, }), ], }); 

I also tightened the auto-instrumented file extension to only typescript files. Tanstack start recommends to use Typescript anyways so this should cover most user applications and including js files leads to tempering with post-transpiled files, which I don't really like. This way we patch the original source and that's it.

Closes#18985

[github-actions]

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario	Requests/s	% of Baseline	Prev. Requests/s	Change %
GET Baseline	8,850	-	9,086	-3%
GET With Sentry	1,709	19%	1,653	+3%
GET With Sentry (error only)	5,968	67%	6,094	-2%
POST Baseline	1,168	-	1,166	+0%
POST With Sentry	575	49%	539	+7%
POST With Sentry (error only)	1,034	89%	1,027	+1%
MYSQL Baseline	3,316	-	3,282	+1%
MYSQL With Sentry	426	13%	393	+8%
MYSQL With Sentry (error only)	2,688	81%	2,680	+0%

View base workflow run

[github-actions]

Codecov Results 📊

---

Generated by Codecov Action

[nicohrubec]

This was an unnecessary option since we just don't add this plugin if it's not enabled, so I removed it

[JPeer264]

l: This was here before - still, maybe it makes more sense to have a path.extname(id) instead and check against this, it might be faster than regex or simply an endsWith (might be more effort, since this one only takes a string)

[JPeer264]

l: I think this should be rather debug.log, where debug comes from @sentry/core

[nicohrubec]

I think this needs to be console.log since it happens during build not runtime

[cursor]

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

[s1gr1d]

Maybe it would make sense to add some defaults here. E.g. excluding the test files if this is a very common usecase

[nicohrubec]

I'll think about this some more and maybe do a follow up, for the test files for instance I think the better approach for us would be to add this to the skipped file extensions early return instead of using this option

[nicohrubec]

Update: So the current state is what I would like this to look like, meaning only patching the original source files so users can reasonably exclude certain files. However, for some reason excluding js files from the transformations results in a slight regression where auto-instrumentation for non-global function middleware is not working anymore. I haven't found an idea yet that would make this work for function middleware. So thinking about closing this. If users want to opt-out they still can be simply disabling middleware auto-instrumentation fully.

[nicohrubec]

Depends on (i.e. do not review until the following PR is merged): #19001

This PR extends the autoInstrumentMiddleware option to support fine-grained control over which files are auto-instrumented. Previously, this option only supported a boolean setting. Now you can pass an object with an exclude array to selectively skip specific files from auto-instrumentation.

// vite.config.ts import { sentryTanstackStart } from '@sentry/tanstackstart-react'; export default defineConfig({ plugins: [ sentryTanstackStart({ autoInstrumentMiddleware: { exclude: [ /\.test\.tsx?$/, // Skip test files ], }, }), ], }); 

I also tightened the auto-instrumented file extension to only typescript files. Tanstack start recommends to use Typescript anyways so this should cover most user applications and including js files leads to tempering with post-transpiled files, which I don't really like. This way we patch the original source and that's it.

Closes#18985

[github-actions]

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario	Requests/s	% of Baseline	Prev. Requests/s	Change %
GET Baseline	8,850	-	9,086	-3%
GET With Sentry	1,709	19%	1,653	+3%
GET With Sentry (error only)	5,968	67%	6,094	-2%
POST Baseline	1,168	-	1,166	+0%
POST With Sentry	575	49%	539	+7%
POST With Sentry (error only)	1,034	89%	1,027	+1%
MYSQL Baseline	3,316	-	3,282	+1%
MYSQL With Sentry	426	13%	393	+8%
MYSQL With Sentry (error only)	2,688	81%	2,680	+0%

View base workflow run

[github-actions]

Codecov Results 📊

---

Generated by Codecov Action

[nicohrubec]

This was an unnecessary option since we just don't add this plugin if it's not enabled, so I removed it

[JPeer264]

l: This was here before - still, maybe it makes more sense to have a path.extname(id) instead and check against this, it might be faster than regex or simply an endsWith (might be more effort, since this one only takes a string)

[JPeer264]

l: I think this should be rather debug.log, where debug comes from @sentry/core

[nicohrubec]

I think this needs to be console.log since it happens during build not runtime

[cursor]

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

[s1gr1d]

Maybe it would make sense to add some defaults here. E.g. excluding the test files if this is a very common usecase

[nicohrubec]

I'll think about this some more and maybe do a follow up, for the test files for instance I think the better approach for us would be to add this to the skipped file extensions early return instead of using this option

[nicohrubec]

Update: So the current state is what I would like this to look like, meaning only patching the original source files so users can reasonably exclude certain files. However, for some reason excluding js files from the transformations results in a slight regression where auto-instrumentation for non-global function middleware is not working anymore. I haven't found an idea yet that would make this work for function middleware. So thinking about closing this. If users want to opt-out they still can be simply disabling middleware auto-instrumentation fully.

[nicohrubec]

Depends on (i.e. do not review until the following PR is merged): #19001

This PR extends the autoInstrumentMiddleware option to support fine-grained control over which files are auto-instrumented. Previously, this option only supported a boolean setting. Now you can pass an object with an exclude array to selectively skip specific files from auto-instrumentation.

// vite.config.ts import { sentryTanstackStart } from '@sentry/tanstackstart-react'; export default defineConfig({ plugins: [ sentryTanstackStart({ autoInstrumentMiddleware: { exclude: [ /\.test\.tsx?$/, // Skip test files ], }, }), ], }); 

I also tightened the auto-instrumented file extension to only typescript files. Tanstack start recommends to use Typescript anyways so this should cover most user applications and including js files leads to tempering with post-transpiled files, which I don't really like. This way we patch the original source and that's it.

Closes#18985

[github-actions]

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario	Requests/s	% of Baseline	Prev. Requests/s	Change %
GET Baseline	8,850	-	9,086	-3%
GET With Sentry	1,709	19%	1,653	+3%
GET With Sentry (error only)	5,968	67%	6,094	-2%
POST Baseline	1,168	-	1,166	+0%
POST With Sentry	575	49%	539	+7%
POST With Sentry (error only)	1,034	89%	1,027	+1%
MYSQL Baseline	3,316	-	3,282	+1%
MYSQL With Sentry	426	13%	393	+8%
MYSQL With Sentry (error only)	2,688	81%	2,680	+0%

View base workflow run

[github-actions]

Codecov Results 📊

---

Generated by Codecov Action

[nicohrubec]

This was an unnecessary option since we just don't add this plugin if it's not enabled, so I removed it

[JPeer264]

l: This was here before - still, maybe it makes more sense to have a path.extname(id) instead and check against this, it might be faster than regex or simply an endsWith (might be more effort, since this one only takes a string)

[JPeer264]

l: I think this should be rather debug.log, where debug comes from @sentry/core

[nicohrubec]

I think this needs to be console.log since it happens during build not runtime

[cursor]

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

[s1gr1d]

Maybe it would make sense to add some defaults here. E.g. excluding the test files if this is a very common usecase

[nicohrubec]

I'll think about this some more and maybe do a follow up, for the test files for instance I think the better approach for us would be to add this to the skipped file extensions early return instead of using this option

[nicohrubec]

Update: So the current state is what I would like this to look like, meaning only patching the original source files so users can reasonably exclude certain files. However, for some reason excluding js files from the transformations results in a slight regression where auto-instrumentation for non-global function middleware is not working anymore. I haven't found an idea yet that would make this work for function middleware. So thinking about closing this. If users want to opt-out they still can be simply disabling middleware auto-instrumentation fully.

[nicohrubec]

Depends on (i.e. do not review until the following PR is merged): #19001

This PR extends the autoInstrumentMiddleware option to support fine-grained control over which files are auto-instrumented. Previously, this option only supported a boolean setting. Now you can pass an object with an exclude array to selectively skip specific files from auto-instrumentation.

// vite.config.ts import { sentryTanstackStart } from '@sentry/tanstackstart-react'; export default defineConfig({ plugins: [ sentryTanstackStart({ autoInstrumentMiddleware: { exclude: [ /\.test\.tsx?$/, // Skip test files ], }, }), ], }); 

I also tightened the auto-instrumented file extension to only typescript files. Tanstack start recommends to use Typescript anyways so this should cover most user applications and including js files leads to tempering with post-transpiled files, which I don't really like. This way we patch the original source and that's it.

Closes#18985

[github-actions]

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario	Requests/s	% of Baseline	Prev. Requests/s	Change %
GET Baseline	8,850	-	9,086	-3%
GET With Sentry	1,709	19%	1,653	+3%
GET With Sentry (error only)	5,968	67%	6,094	-2%
POST Baseline	1,168	-	1,166	+0%
POST With Sentry	575	49%	539	+7%
POST With Sentry (error only)	1,034	89%	1,027	+1%
MYSQL Baseline	3,316	-	3,282	+1%
MYSQL With Sentry	426	13%	393	+8%
MYSQL With Sentry (error only)	2,688	81%	2,680	+0%

View base workflow run

[github-actions]

Codecov Results 📊

---

Generated by Codecov Action

[nicohrubec]

This was an unnecessary option since we just don't add this plugin if it's not enabled, so I removed it

[JPeer264]

l: This was here before - still, maybe it makes more sense to have a path.extname(id) instead and check against this, it might be faster than regex or simply an endsWith (might be more effort, since this one only takes a string)

[JPeer264]

l: I think this should be rather debug.log, where debug comes from @sentry/core

[nicohrubec]

I think this needs to be console.log since it happens during build not runtime

[cursor]

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

[s1gr1d]

Maybe it would make sense to add some defaults here. E.g. excluding the test files if this is a very common usecase

[nicohrubec]

I'll think about this some more and maybe do a follow up, for the test files for instance I think the better approach for us would be to add this to the skipped file extensions early return instead of using this option

[nicohrubec]

Update: So the current state is what I would like this to look like, meaning only patching the original source files so users can reasonably exclude certain files. However, for some reason excluding js files from the transformations results in a slight regression where auto-instrumentation for non-global function middleware is not working anymore. I haven't found an idea yet that would make this work for function middleware. So thinking about closing this. If users want to opt-out they still can be simply disabling middleware auto-instrumentation fully.

[nicohrubec]

Depends on (i.e. do not review until the following PR is merged): #19001

This PR extends the autoInstrumentMiddleware option to support fine-grained control over which files are auto-instrumented. Previously, this option only supported a boolean setting. Now you can pass an object with an exclude array to selectively skip specific files from auto-instrumentation.

// vite.config.ts import { sentryTanstackStart } from '@sentry/tanstackstart-react'; export default defineConfig({ plugins: [ sentryTanstackStart({ autoInstrumentMiddleware: { exclude: [ /\.test\.tsx?$/, // Skip test files ], }, }), ], }); 

I also tightened the auto-instrumented file extension to only typescript files. Tanstack start recommends to use Typescript anyways so this should cover most user applications and including js files leads to tempering with post-transpiled files, which I don't really like. This way we patch the original source and that's it.

Closes#18985

[github-actions]

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario	Requests/s	% of Baseline	Prev. Requests/s	Change %
GET Baseline	8,850	-	9,086	-3%
GET With Sentry	1,709	19%	1,653	+3%
GET With Sentry (error only)	5,968	67%	6,094	-2%
POST Baseline	1,168	-	1,166	+0%
POST With Sentry	575	49%	539	+7%
POST With Sentry (error only)	1,034	89%	1,027	+1%
MYSQL Baseline	3,316	-	3,282	+1%
MYSQL With Sentry	426	13%	393	+8%
MYSQL With Sentry (error only)	2,688	81%	2,680	+0%

View base workflow run

[github-actions]

Codecov Results 📊

---

Generated by Codecov Action

[nicohrubec]

This was an unnecessary option since we just don't add this plugin if it's not enabled, so I removed it

[JPeer264]

l: This was here before - still, maybe it makes more sense to have a path.extname(id) instead and check against this, it might be faster than regex or simply an endsWith (might be more effort, since this one only takes a string)

[JPeer264]

l: I think this should be rather debug.log, where debug comes from @sentry/core

[nicohrubec]

I think this needs to be console.log since it happens during build not runtime

[cursor]

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

[s1gr1d]

Maybe it would make sense to add some defaults here. E.g. excluding the test files if this is a very common usecase

[nicohrubec]

I'll think about this some more and maybe do a follow up, for the test files for instance I think the better approach for us would be to add this to the skipped file extensions early return instead of using this option

[nicohrubec]

Update: So the current state is what I would like this to look like, meaning only patching the original source files so users can reasonably exclude certain files. However, for some reason excluding js files from the transformations results in a slight regression where auto-instrumentation for non-global function middleware is not working anymore. I haven't found an idea yet that would make this work for function middleware. So thinking about closing this. If users want to opt-out they still can be simply disabling middleware auto-instrumentation fully.