Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(custom-resources): log group name for waiter state machine does not start with /aws/vendedlogs/states/ (under feature flag) #28587

Closed

Conversation

go-to-k
Copy link
Contributor

@go-to-k go-to-k commented Jan 5, 2024

Until now, the default log group name of the state machine automatically created by the Provider with isCompleteHandler did not start with /aws/vendedlogs/states. Therefore, each time the state machine is created, the log resource policy size increases. To prevent this, the log group name of automatically created logs now starts with /aws/vendedlogs/states.

Closes #28577.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

…CompleteHandler does not start `/aws/vendedlogs/states` (under feature flag)
@github-actions github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p1 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Jan 5, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team January 5, 2024 09:43
@go-to-k go-to-k changed the title fix(custom-resources): log group name for state machine generated in CompleteHandler does not start with /aws/vendedlogs/states (under feature flag) fix(custom-resources): log group name for waiter state machine does not start with /aws/vendedlogs/states (under feature flag) Jan 5, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@go-to-k go-to-k changed the title fix(custom-resources): log group name for waiter state machine does not start with /aws/vendedlogs/states (under feature flag) fix(custom-resources): log group name for waiter state machine does not start with /aws/vendedlogs/states/ (under feature flag) Jan 5, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review January 5, 2024 12:47

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@go-to-k go-to-k marked this pull request as draft January 5, 2024 13:11
@go-to-k go-to-k marked this pull request as ready for review January 5, 2024 16:57
const logGroup = logOptions?.destination ?? new LogGroup(this, 'LogGroup');
const logGroupName =
FeatureFlags.of(this).isEnabled(cxapi.WAITER_STATE_MACHINE_LOG_GROUP_NAME)
? `/aws/vendedlogs/states/waiter-state-machine-${this.isCompleteHandler.functionName}-${this.node.addr}`
Copy link
Contributor Author

@go-to-k go-to-k Jan 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

node.addr is used to prevent duplicate names no matter how many times this construct is created in the stack. It will not duplicate if called on other stacks.
Also, by using the (auto-generated) name of the Lambda created in the Provider that calls this WaiterStateMachine construct, even if the Provider (or its parent) is deleted and then created again, the log group name will not duplicate previously created one with removal policy RETAIN. (This is because that lambda will be re-created again with auto-generated name.)

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 277023c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 5, 2024
@go-to-k
Copy link
Contributor Author

go-to-k commented Jan 13, 2024

I am going to take the original issue with correct changes in a new PR.

#28577 (comment)

@go-to-k go-to-k closed this Jan 13, 2024
mergify bot pushed a commit that referenced this pull request Apr 19, 2024
… in CompleteHandler (#28706)

This PR fixes the case that `StateMachine` generated for `CompleteHandler` in `Provider` cannot set logging.

The default log group name of the state machine automatically created by the `Provider` with `isCompleteHandler` should start with `/aws/vendedlogs/states`. Otherwise, each time the state machine is created, the log resource policy size increases. 

https://docs.aws.amazon.com/step-functions/latest/dg/bp-cwl.html

Closes #27283
Fixes #28577 #28744

Related PR #27310(reverted by #28699), #28587

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. distinguished-contributor [Pilot] contributed 50+ PRs to the CDK effort/medium Medium work item – several days of effort p1 pr/needs-maintainer-review This PR needs a review from a Core Team Member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(custom-resources): Default logging configuration hits Cloudwatch Logs Resource Policy size limit
2 participants