feat: Add a param isFIPSEnabled #598
Conversation
README.md
Outdated
| @@ -66,6 +66,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`. | | |||
| | `enableFIPS` | When set to `true`, a FIPS-compliant lambda extension layer will be used. Only works if `addExtension` is `true` and `site` is `ddog-gov.com`. Defaults to `false`. | | |||
There was a problem hiding this comment.
| | `enableFIPS` | When set to `true`, a FIPS-compliant lambda extension layer will be used. Only works if `addExtension` is `true` and `site` is `ddog-gov.com`. Defaults to `false`. | | |
| | `enableFIPS` | When set to `true`, a FIPS-compliant Lambda extension layer is used. This only works if `addExtension` is `true`, and `site` is `ddog-gov.com`. Defaults to `false`. | |
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
src/env.ts
Outdated
|
|
||
| // When set to `true`, a FIPS-compliant lambda extension layer will be used. | ||
| // Only works if `addExtension` is `true` and `site` is `ddog-gov.com`. | ||
| enableFIPS?: boolean; |
There was a problem hiding this comment.
⚪ Code Quality Violation
Prop name (enableFIPS) doesn't match rule (is|has) (...read more)
Enforces a consistent naming pattern for boolean props.
The pattern is: "^(is|has)[A-Z]([A-Za-z0-9]?)+" to enforce is and has prefixes.
There was a problem hiding this comment.
➕ Boolean params should follow the patter of starting with is or has. So this should be isFipsEnabled or isFIPSEnabled
There was a problem hiding this comment.
enableFIPS follows the naming of other parameters including enableXrayTracing, enableDDTracing, enableASM, enableDDLogs, enableSourceCodeIntegration, enableColdStartTracing, enableProfiling, enableStepFunctionsTracing. Do you think we should break this pattern?
There was a problem hiding this comment.
Yes, we should slowly move to the new pattern. This is a pattern that Datadog is starting to enforce across the company. We don't want to add more to Code Quality Violation
README.md
Outdated
| @@ -66,6 +66,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`. | | |||
| | `enableFIPS` | When set to `true`, a FIPS-compliant Lambda extension layer is used. This only works if `addExtension` is `true`, and `site` is `ddog-gov.com`. Defaults to `false`. | | |||
There was a problem hiding this comment.
We should default this prop to true when we see that site is ddog-gov.com.
What does this PR do?
Add a param
isFIPSEnabled. If set, the extension layer used will be like:instead of
Motivation
Needed for FIPS support.
Testing Guidelines
Passed the added tests.
Additional Notes
Types of changes
Check all that apply