Skip to content

Commit d970ca4

Browse files
authored
docs(js): Clarify behavior of timeoutWarningLimit in AWS (#14286)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR resolves getsentry/sentry-javascript#9810 ## 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.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] 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](https://github.com/orgs/getsentry/teams/docs)
1 parent 59d2225 commit d970ca4

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/platforms/javascript/guides/aws-lambda/configuration/lambda-wrapper.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ exports.handler = Sentry.wrapHandler(yourHandler, {
2020

2121
## Timeout Warning
2222

23-
Sentry reports timeout warnings when the Lambda function is within 500ms of its execution time. You can turn off timeout warnings by setting `captureTimeoutWarning` to `false` in the handler options.
23+
Sentry reports timeout warnings when the Lambda function is within 500ms of the configured Lambda timeout. You can turn off timeout warnings by setting `captureTimeoutWarning` to `false` in the handler options.
2424

2525
```javascript {filename:index.js} {2}
2626
exports.handler = Sentry.wrapHandler(yourHandler, {
2727
captureTimeoutWarning: false,
2828
});
2929
```
3030

31-
To change the timeout warning limit, assign a numeric value (in ms) to `timeoutWarningLimit`:
31+
To change the timeout warning limit, assign a numeric value (in ms) to `timeoutWarningLimit`. This value specifies the time left before the warning is triggered.
3232

3333
```javascript {filename:index.js} {2}
3434
exports.handler = Sentry.wrapHandler(yourHandler, {
35-
timeoutWarningLimit: 700,
35+
timeoutWarningLimit: 700, // Warn when within 700ms of timeout
3636
});
3737
```
3838

0 commit comments

Comments
 (0)