Automatically notify when a lambda may timeout #1324
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We can never be 100% sure that a timeout will happen because we need to notify with enough time for the event to be delivered. Therefore this is a best effort with a generous default value (1000ms) that errs on the side of delivering the warning at the cost of possible false positives The default value can be changed by providing "lambdaTimeoutNotifyMs" to createHandler. This is useful in cases where the lambda function is very quick to execute and so can have a very short timeout without necessarily being at risk of timing out If set to "0" we don't bother adding the warning at all. This is largely arbitrary as a value of 0 would never be triggered (because the lambda would timeout at the same time)
|
| Minified | Minfied + Gzipped | |
|---|---|---|
| Before | 40.83 kB |
12.60 kB |
| After | 40.83 kB |
12.60 kB |
| ± | No change | No change |
code coverage diff
| Ok | File | Lines | Branches | Functions | Statements |
|---|---|---|---|---|---|
| 🔴 | /home/runner/work/bugsnag-js/bugsnag-js/packages/plugin-aws-lambda/src/index.js | 94.64% (+1.46%) |
94.29% (-1.54%) |
90.91% (+0.91%) |
94.64% (+1.46%) |
| ✅ | /home/runner/work/bugsnag-js/bugsnag-js/packages/plugin-aws-lambda/src/lambda-timeout-approaching.js | 100% (+100%) |
100% (+100%) |
100% (+100%) |
100% (+100%) |
Total:
| Lines | Branches | Functions | Statements |
|---|---|---|---|
| 81.51%(+0.11%) | 70.37%(+0.15%) | 84.01%(+0.05%) | 80.42%(+0.1%) |
There's no point adding the timeout at all if it's too big as it will never trigger
bengourley
approved these changes
Mar 4, 2021
This is already handled by the 'super' call
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal
We can never be 100% sure that a timeout will happen because we need to notify with enough time for the event to be delivered. Therefore this is a best effort with a generous default value (1000ms) that errs on the side of delivering the warning at the cost of possible false positives. The default value can be changed by providing the new
lambdaTimeoutNotifyMsparameter tocreateHandler, e.g.:If set to "0" we don't bother adding the warning at all. This is largely arbitrary as a value of 0 would never be triggered (because the lambda would timeout at the same time so we would never be able to deliver the event) but it allows users to turn this feature off if they don't want it
Testing
This can only be covered by unit tests because of a bug in AWS' SAM CLI: aws/aws-sam-cli#2519
In short, SAM returns a Unix timestamp from
getRemainingTimeInMillisso the timeout could never be triggered withsam local invoke(short of mocking the function, which isn't really better than a unit test)