feat: Prefix the CloudWatch Log group name with /aws/vendedlogs/states/
#52
Conversation
This file contains hidden or 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
per https://docs.aws.amazon.com/step-functions/latest/dg/bp-cwl.html Co-authored-by: noel.jorden@highwing.io
plukevdh
changed the title
/aws/vendedlogs/states/
plukevdh
changed the title
/aws/vendedlogs/states//aws/vendedlogs/states/
bryantbiggs
approved these changes
May 17, 2023
antonbabenko
pushed a commit
that referenced
this pull request
May 17, 2023
## [3.1.0](v3.0.0...v3.1.0) (2023-05-17) ### Features * Prefix the CloudWatch Log group name with `/aws/vendedlogs/states/` ([#52](#52)) ([3964cb3](3964cb3))
|
This PR is included in version 3.1.0 🎉 |
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
per https://docs.aws.amazon.com/step-functions/latest/dg/bp-cwl.html
Co-authored-by: @njorden
Description
The AWS StepFunction docs suggest prefixing the log group for step functions with "/aws/vendedlogs/states" to avoid message size limits. This is also the default for any group created via the console itself. This seems like a reasonable default for log groups created implicitly (i.e., when not named by the TF config).
Vendors like Datadog also expects logs to be prefixed as such in order to tag the logging as
source:stepfunction.Motivation and Context
AWS provides what appears to be a best practice guidance here that I think is worth following for implicit log group creation. It doesn't break anywhere that people already name their log groups.
Resolves #36
Breaking Changes
Does not break anything but will cause destructive changes to anyone using this module.
How Has This Been Tested?
examples/*to demonstrate and validate my change(s)examples/*projectspre-commit run -aon my pull request