Skip to content

Commit

Permalink
Fix readme file and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
enricop89 committed Dec 20, 2024
1 parent 8045d28 commit 2e32437
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@ To further configure your plugin, use the following custom parameters in your `s
| `enableASM` | Enable [Datadog Application Security Management (ASM)][19] on the Lambda function. Requires the Datadog extension to be present (using `addExtension` or manually added) and `enableDDTracing`. Defaults to `false`. |
| `enableDDLogs` | Enable Datadog log collection using the Lambda Extension. Defaults to `true`. Note: This setting has no effect on logs sent by the Datadog Forwarder. |
| `monitors` | When defined, the Datadog plugin configures monitors for the deployed function. Requires setting `DATADOG_API_KEY` and `DATADOG_APP_KEY` in your environment. To learn how to define monitors, see [To Enable and Configure a Recommended Serverless Monitor](#to-enable-and-configure-a-recommended-serverless-monitor). |
| `captureLambdaPayload` | [Captures incoming and outgoing AWS Lambda payloads][17] in the Datadog APM spans for Lambda invocations. Defaults to `false`.
| `captureCloudRequestPayload` | [Captures request data exchanged between your application and AWS services][20] in the Datadog APM spans. Values: `all`. To [protect sensitive data][21], use JSON Path syntax.. Defaults to `false`.
| `captureCloudResponsePayload` | [Captures response data exchanged between your application and AWS services][20] in the Datadog APM spans.Values: `all`. To [protect sensitive data][21], use JSON Path syntax.`""`. |
| `captureLambdaPayload` | [Captures incoming and outgoing AWS Lambda payloads][17] in the Datadog APM spans for Lambda invocations. Defaults to `false`.
|
| `captureCloudRequestPayload` | | `captureCloudRequestPayload` | When using an AWS SDK client within your lambda function, captures [request data exchanged between it and AWS services][20] in the Datadog APM spans. Values: `all`. To [protect sensitive data][21], use JSON Path syntax. Defaults to `""`. |
|
| `captureCloudResponsePayload` | When using an AWS SDK client within your lambda function, [captures response data exchanged between it and AWS services][20] in the Datadog APM spans.Values: `all`. To [protect sensitive data][21], use JSON Path syntax. Defaults to `""`. | |
| `enableSourceCodeIntegration` | Enable [Datadog Source Code Integration][18] for the function. Defaults to `true`. |
| `uploadGitMetadata` | Enable Git metadata uploading for the function, as a part of source code integration. Set this to false if you have the Datadog Github Integration installed, as it renders Git metadata uploading unnecessary. Defaults to `true`. |
| `subscribeToAccessLogs` | Enable automatic subscription of the Datadog Forwarder to API Gateway access log groups. Requires setting `forwarderArn`. Defaults to `true`. |
Expand Down
4 changes: 2 additions & 2 deletions src/env.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ export interface Configuration {
apiKMSKey?: string;
// Whether to capture and store the payload and response of a lambda invocation
captureLambdaPayload?: boolean;
// Wheter to capture and store the AWS Payload requests services
// Whether to capture and store the AWS Payload requests services
captureCloudRequestPayload?: string;
// Wheter to capture and store the AWS Payload response services
// Whether to capture and store the AWS Payload response services
captureCloudResponsePayload?: string;
// Which Datadog site to send to (for example, datadoghq.com or datadoghq.eu)
site: string;
Expand Down

0 comments on commit 2e32437

Please sign in to comment.