Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ref(node/serverless): Add note about performance impact of auto discovery of integrations #7245

Merged
merged 3 commits into from
Jun 29, 2023
Merged

ref(node/serverless): Add note about performance impact of auto discovery of integrations #7245

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cef61e9
ref(node/serverless): Add note about performance impact of integrations
Lms24 Jun 22, 2023
8210f97
Apply suggestions from code review
Lms24 Jun 29, 2023
2d474aa
review suggestions
Lms24 Jun 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion ...platforms/node/common/performance/instrumentation/automatic-instrumentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ Read more about [Custom Instrumentation](./../custom-instrumentation/) to learn

<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.
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` might degrade startup performance of your app. This is especially a concern in Serverless functions. If you're experiencing this, manually add [database integrations](../../database/) of your choice instead (see example below).
Lms24 marked this conversation as resolved.
Show resolved Hide resolved
Lms24 marked this conversation as resolved.
Show resolved Hide resolved
Lms24 marked this conversation as resolved.
Show resolved Hide resolved

</Note>

Expand All @@ -28,7 +30,11 @@ Sentry.init({
// enable HTTP calls tracing
new Sentry.Integrations.Http({ tracing: true }),
// Automatically instrument Node.js libraries and frameworks
// (This might degrade startup performance)
Lms24 marked this conversation as resolved.
Show resolved Hide resolved
...Sentry.autoDiscoverNodePerformanceMonitoringIntegrations(),
// Or manually add integrations of your choice. For example:
Sentry.Integrations.Apollo(),
Sentry.Integraionts.Postgres(),
],

// We recommend adjusting this value in production, or using tracesSampler
Expand Down