ModusCreateOrg / ModusCreateOrg/devops-infra-demo
Pick and then use a better naming convention for CloudWatch logs than is present currently
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 34
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
In the ticket where we originally added CloudWatch we used these CloudWatch log group names, which are short, but don't group well or show up together when you go into the CloudWatch console.
Original CloudWatch Log Group Names
Put in a syslog log group:
/var/log/boot.log
/var/log/cron
/var/log/messages
/var/log/dmesg
/var/log/secure
/var/log/spooler
/var/log/maillog
Put in an package-updates log group:
/var/log/yum.log
Put in an selinux log group:
/var/log/audit/audit.log
NGINX nginex-access
/var/log/nginx/access.log
NGINX nginex-error
/var/log/nginx/error.log
We should research and take some inspiration from other CloudWatch log groups seen in the wild, such as:
/aws/greengrass/Lambda/us-east-1/976851222302/deeplens-face-detection
/aws/codebuild/capsule-andycapsuletest-ci-capsule-andycapsuletest-ci
Considerations for renaming them
The log groups get dynamically created so all we have to do is edit the config.json file, run packer, and apply terraform to have the new names take effect.
Resources
- https://confluence.huit.harvard.edu/display/CLA/Cloud+Resource+Naming+Conventions#CloudResourceNamingConventions-CloudWatchLogGroups
- https://www.reddit.com/r/aws/comments/bzs0dy/naming_conventions_for_cloudwatch_groups/
- https://stackoverflow.com/questions/42630232/is-it-possible-to-rename-an-aws-cloudwatch-log-group
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing ansible/roles/cloudwatch-agent/files/config.json and the linked CloudWatch naming resources. Compare naming conventions, choose a consistent scheme for the listed log groups, then run packer and apply terraform as described to make the names take effect. Done means the configuration uses the selected convention for all listed groups.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ansible, aws, terraform
- Domain
- cloud, devops, infrastructure
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100