Enable step function tracing at forwarder level #831
Conversation
| @@ -32,6 +33,12 @@ def enrich(events, cache_layer): | |||
| extract_host_from_guardduty(event) | |||
| extract_host_from_route53(event) | |||
|
|
|||
| # Set tracing behavior for all step functions | |||
| if DD_STEP_FUNCTION_TRACE_ENABLED: | |||
| event[DD_CUSTOM_TAGS] = ",".join( | |||
There was a problem hiding this comment.
Null check for event[DD_CUSTOM_TAGS] ?
There was a problem hiding this comment.
Will be moving this logic as per Kimi's comment and adding a null check on the entry
| SetDdStepFunctionTraceEnabled: | ||
| Fn::Equals: | ||
| - Ref: DdStepFunctionTraceEnabled | ||
| - true |
There was a problem hiding this comment.
What will be the default value in CloudFormation console (shown as below) when customer install a new DD forwarder?
It should be default false, but customers can set it to be true if they want.
There was a problem hiding this comment.
The console will use the default value in Parameters: section, so in this case it would be false.
There was a problem hiding this comment.
This should be the default behavior, here is the flow
- Template has the default for the
DdStepFunctionTraceEnabledto befalse SetDdStepFunctionTraceEnabledcondition will then befalsebecauseDdStepFunctionTraceEnabled != trueDD_STEP_FUNCTION_TRACE_ENABLEDwill beAWS::NoValue, which means the env var won't be set
| if DD_STEP_FUNCTION_TRACE_ENABLED: | ||
| event[DD_CUSTOM_TAGS] = ",".join( | ||
| [event[DD_CUSTOM_TAGS]] + ["dd_step_function_trace_enabled:true"] | ||
| ) |
There was a problem hiding this comment.
I think we should to add the step functions specific logic to handle_step_function_source().
We'd also want to do the empty value (e.g. "") check like this one:
There was a problem hiding this comment.
I moved the logic to the handle_step_function_source() but I used a slightly different approach with the join so I don't think need the empty check
| SetDdStepFunctionTraceEnabled: | ||
| Fn::Equals: | ||
| - Ref: DdStepFunctionTraceEnabled | ||
| - true |
There was a problem hiding this comment.
The console will use the default value in Parameters: section, so in this case it would be false.
| @@ -184,6 +185,12 @@ def handle_step_function_source(self): | |||
| + ",".join(formatted_stepfunctions_tags) | |||
| ) | |||
|
|
|||
| if DD_STEP_FUNCTION_TRACE_ENABLED: | |||
|
LGTM. |
avedmala
changed the title
What does this PR do?
This PR adds logic to allow users to enable tracing for all their Step Functions via the
dd_step_function_trace_enabledtagThis tag can be set via the
DdStepFunctionTraceEnabledCloudFormation parameter which is used to set theDD_STEP_FUNCTION_TRACE_ENABLEDenv varLink to log with the new tag and screenshot of the tag
Motivation
Testing Guidelines
Additional Notes
Types of changes
Check all that apply