[Step Function][DRAFT] Set up logging #143
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
|
|
||
| export interface LoggingConfiguration { | ||
| Destinations?: LogDestination[]; | ||
| IncludeExecutionData?: boolean; |
There was a problem hiding this comment.
⚪ Code Quality Violation
Prop name (IncludeExecutionData) 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.
|
|
||
| export interface StateMachineProperties { | ||
| LoggingConfiguration?: LoggingConfiguration; | ||
| RoleArn?: string | { [key: string]: any }; |
There was a problem hiding this comment.
⚪ Code Quality Violation
Unexpected any. Specify a different type. (...read more)
Do not use the any type, as it is too broad and can lead to unexpected behavior.
|
|
||
| // Same interface as Configuration above, except all parameters are optional, since user does | ||
| // not have to provide the values (in which case we will use the default configuration below). | ||
| interface CfnParams extends Partial<Configuration> {} |
There was a problem hiding this comment.
⚪ Code Quality Violation
An empty interface is equivalent to `{}`. (...read more)
Do not use empty interfaces.
lym953
force-pushed
the
yiming.luo/step-function-3
branch
from
c9fcce4 to
c1df317
Compare
Base automatically changed from
yiming.luo/step-function-3
to
yiming.luo/step-function
January 3, 2025 22:00
10 tasks
lym953
force-pushed
the
yiming.luo/step-function-4
branch
from
955f3a6 to
a54a52c
Compare
lym953
changed the title
This was referenced Jan 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Enables setting up logging for a given state machine:
Motivation
This is the first step of instrumenting a step function.
Testing Guidelines
Automated Testing
Passed the added tests.
Manual Testing
Steps
aws-vault exec sso-serverless-sandbox-account-admin -- tools/create_test_stack.shto deploy the macro to sandboxDatadogServerlesstransformResult
Additional Notes
Sorry for making this PR so large, but partially set up logging can cause deployment failures in manual test. For example, if log level is ALL and log group is not set, then deployment will fail. Please let me know if any code is not clear to you.
Types of changes
Check all that apply