Feat/node lambda docs #2204
Feat/node lambda docs #2204
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sentry/sentry-docs/1iluvd09w/sentry.dev |
Objective: We want to customize the sidebar of the OpenAPI docs and show something similar to the Stripe docs. If a user wants to exit the OpenAPI Reference then they can use the breadcrumbs navigation.
| @@ -4,6 +4,9 @@ redirect_from: | |||
| - /platforms/node/aws_lambda/ | |||
| --- | |||
|
|
|||
| *Verify Version* | |||
| _(New in version 5.22.4 - Lambda integration is in Beta)_ | |||
| dsn: | ||
| "___PUBLIC_DSN___", |
There was a problem hiding this comment.
| dsn: | |
| "___PUBLIC_DSN___", | |
| dsn: "___PUBLIC_DSN___" |
| @@ -16,37 +19,60 @@ $ npm install --save @sentry/node | |||
| $ yarn add @sentry/node | |||
| ``` | |||
|
|
|||
| To set up Sentry error logging for a Lambda Function, build a wrapper: | |||
| You can use the AWS Lambda integration for the Node SDK like this: | |||
There was a problem hiding this comment.
I'd remove the SDK part from the Node SDK
| "___PUBLIC_DSN___", | ||
| }); | ||
|
|
||
| const myAsyncHandler = async (event, context, callback) => { |
There was a problem hiding this comment.
| const myAsyncHandler = async (event, context, callback) => { | |
| const myAsyncHandler = async (event, context) => { |
async functions are mutually exclusive with callback. It's either async or sync with callback.
|
|
||
| Sentry reports timeout warning when the function is within 500ms of it's execution time. You can turn off timeout warnings by setting `captureTimeoutWarning` to `false` during initiatlization. To change timeout warning limit, assign a numeric value (in ms) to `timeoutWarning`. |
There was a problem hiding this comment.
This is now how options are set for handlers.
Sentry.AWSLambda.wrapHandler(yourHandler, {
captureTimeoutWarning: false
});So both, description and code examples are incorrect.
| }); | ||
| ``` | ||
|
|
||
| You can obtain the DSN using your Sentry account from your organization's _Settings > Projects > Client Keys (DSN)_ in the Sentry web UI. | ||
| The timeout warning is sent only if the "timeout" in the Lambda Function configuration is set to a value greater than one second. |
There was a problem hiding this comment.
There's nothing stopping you from setting timeout to 1s and still capture the warning if limit is small enough.
|
|
||
| Create the deployment package in `.zip` format, then upload it to AWS Lambda as a Lambda Function. Checkout Sentry's [aws sample apps](https://github.com/getsentry/examples/tree/master/aws-lambda/node) for detailed examples. Refer to the [JavaScript docs](/platforms/javascript/) for more configuration options. | ||
| - Sentry holds the thread for upto 2 seconds to report errors. You can change flush time limit by defining a `flushTimeout` value during initiatlization |
There was a problem hiding this comment.
in the handler options*
| @@ -16,33 +17,43 @@ $ npm install --save @sentry/node | |||
| $ yarn add @sentry/node | |||
| ``` | |||
|
|
|||
| To set up Sentry error logging for a Lambda Function, build a wrapper: | |||
| You can use the AWS Lambda integration for the Node SDK like this: | |||
There was a problem hiding this comment.
All the comments apply to this file as well, so I won't double-post them.
|
Outdated |
Latest Node AWS integration docs update