Skip to content

docs(node): Add docs for maxIncomingRequestBodySize and ignoreIncomingRequestBody #13698

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Merged
merged 2 commits into from
May 20, 2025
Merged

docs(node): Add docs for maxIncomingRequestBodySize and ignoreIncomingRequestBody #13698

merged 2 commits into from
May 20, 2025

Conversation

s1gr1d
Copy link
Member

@s1gr1d s1gr1d commented May 14, 2025

DESCRIBE YOUR PR

Documents ignoreIncomingRequestBody : getsentry/sentry-javascript#15959

Documents maxIncomingRequestBodySize: getsentry/sentry-javascript#16225

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@s1gr1d s1gr1d requested a review from mydea May 14, 2025 11:09
@vercel Vercel
Copy link

vercel bot commented May 14, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 20, 2025 0:39am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview May 20, 2025 0:39am
develop-docs ⬜️ Ignored (Inspect) Visit Preview May 20, 2025 0:39am

@s1gr1d s1gr1d requested review from Lms24 and sfanahata May 14, 2025 11:10
s1gr1d
s1gr1d commented May 14, 2025
View reviewed changes
docs/platforms/javascript/common/configuration/integrations/http.mdx Outdated
Comment on lines 80 to 81
- `url`: The full URL of the outgoing request, including the protocol, host, port, path and query string. For example: `https://example.com/users?name=John`.
- `request`: An object of type `RequestOptions` containing the outgoing request's options. You can use this to filter on properties like the request method or headers.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While writing the docs here and checking them with the JSDoc I am not 100% sure if the underlying JSDocs are correct 🤔

They mention the types of the outgoing request. But shouldn't this be the incoming? https://github.com/getsentry/sentry-javascript/pull/15959/files#diff-964fee03880b5de6d711130f1ad4111d04e194bc066ea1725b4e6b7c1c722a42

Copy link
Contributor

@sfanahata sfanahata May 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just coming here to ask the same thing. Shouldn't it say "the full URL of the incoming request"?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oof, good catch, I think this was copy pasta from ignoreOutgoingRequests. I'll quickly fix this in the JSDoc. Let's make sure we fix this in this PR as well, thanks :)

@codecov Codecov
Copy link

codecov bot commented May 14, 2025 •
edited
Loading

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.19MB -9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.51MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 868.7kB -0.0%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/hC4N8lUIfoptDNldfv_L_/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/hC4N8lUIfoptDNldfv_L_/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/OaRKtQtS8MMRz7mQSPxn4/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/OaRKtQtS8MMRz7mQSPxn4/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Lms24
Lms24 approved these changes May 19, 2025
View reviewed changes
Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and good catch with the JSDoc!

docs/platforms/javascript/common/configuration/integrations/http.mdx
Copy link
Member

@Lms24 Lms24 May 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just noticed this:

image

Probably an issue on its own, so feel free to leave as-is for this PR

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

created a PR: #13769

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing, thanks for doing this!

docs/platforms/javascript/common/configuration/integrations/http.mdx Outdated
Comment on lines 80 to 81
- `url`: The full URL of the outgoing request, including the protocol, host, port, path and query string. For example: `https://example.com/users?name=John`.
- `request`: An object of type `RequestOptions` containing the outgoing request's options. You can use this to filter on properties like the request method or headers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oof, good catch, I think this was copy pasta from ignoreOutgoingRequests. I'll quickly fix this in the JSDoc. Let's make sure we fix this in this PR as well, thanks :)

@codeowner-assignment codeowner-assignment bot requested review from a team May 20, 2025 12:23
@s1gr1d s1gr1d merged commit 8df2fe1 into master May 20, 2025
13 checks passed
@s1gr1d s1gr1d deleted the sig/document-http-settings branch May 20, 2025 14:38
@github-actions github-actions bot locked and limited conversation to collaborators Jun 6, 2025
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Reviewers

@Lms24 Lms24 Lms24 approved these changes

@mydea mydea Awaiting requested review from mydea

@sfanahata sfanahata Awaiting requested review from sfanahata

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@s1gr1d @Lms24 @sfanahata