diff --git a/README.md b/README.md index 7f9aba31..70781e0f 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ To further configure your plugin, use the following custom parameters in your `s | `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` | 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`. | @@ -66,6 +68,7 @@ To further configure your plugin, use the following custom parameters in your `s | `enableStepFunctionsTracing` | Enable automatic subscription of the Datadog Forwarder to Step Function log groups and Step Functions tracing. If no Step Function log groups are configured, then they are automatically created. Requires setting `forwarderArn`. Defaults to `false`. | | `propagateUpstreamTrace` | When set to `true`, downstream Stepfunction invocation traces merge with upstream Stepfunction invocations. Defaults to `false`. | | `redirectHandlers` | Optionally disable handler redirection if set to `false`. This should only be set to `false` when APM is fully disabled. Defaults to `true`. | + To use any of these parameters, add a `custom` > `datadog` section to your `serverless.yml` similar to this example: ```yaml @@ -263,3 +266,5 @@ This product includes software developed at Datadog (