Name: cloudwatch-dashboards-cloudformation-sample
Owner: Amazon Web Services - Labs
Owner: AWS Samples
Description: A sample project to demonstrate using Cloudformation, how to create and configure CloudWatch metric filters, alarms and a dashboard to monitor an AWS Lambda function.
Created: 2017-07-16 01:40:26.0
Updated: 2017-12-11 22:24:24.0
Pushed: 2017-07-27 15:11:48.0
Size: 14
Language: Makefile
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This is a sample project called 'CodeBuddy'. This is to demonstrate using Cloudformation, how to create and configure CloudWatch metric filters, alarms and a dashboard to monitor an AWS Lambda function.
Code Buddy is a utility designed to run on AWS using Lambda and SNS. On daily basis it will send an email to a mailing list (SNS Topic) used by a team. This notification will contain the code buddies assignations for the team members. The default template looks like:
is week n.30, for this week the code buddies are:
Augustus's code-buddy is Hadrian
Gaius Caligula's code-buddy is Marcus Aurelius
Nero's code-buddy is Constantine the Great
Hadrian's code-buddy is Justinian
Marcus Aurelius's code-buddy is Augustus
Constantine the Great's code-buddy is Gaius Caligula
Justinian's code-buddy is Nero
The installation steps are the following:
Makefile parameterscodebuddy user in our account with credentials pairCodeBuddyCloudformationPolicy and attach to codebuddy userAt the beginning of the Makefile are defined a set of parameters that most probably you want to change. Here the description of all parameters, at least you would like to change the team members names:
ET_NAME # is the name of the S3 bucket used by this utility
BOARD_NAME # is the name of the CloudWatch dashboard you will use to monitor this utility
TION_NAME # is the name of the Lambda function that will run this utility
ING_LIST # is the mailing list to which the utility will send the notifications
ON # is the AWS region where all the necessary resources will be created
DULE_EXPRESSION # is the cron expression in GMT time to set the frequency of notifications
K_NAME # is the name of the Cloudformation stack that will be created
LATE_FILENAME # is the filename of the template used for the notifications
_MEMBER_NAMES # the names of the team members
In order to install this utility into your AWS account and correctly execute the scripts of this project you have to create a new user called codebuddy and give it a programmatic access. For the moment have to attach to this user the IAMFullAccess existing policy. In the step 4 you will create a more fine grained policy and will remove this one.
In the last step of user creation you will get Access and Secret keys for codebuddy user. Copy that credentials in your ~/.aws/credentials file something like:
ebuddy]
access_key_id = AKIAXXXXXXXXXXXXXXXX
secret_access_key = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
on = eu-west-1
If you need to learn more go to official documentation.
The next step is to define fine grained permissions. In order to create the policy with all the necessary permissions needed to create the CloudFormation stack, you have to execute the following command in the project root folder:
ake stack-policy
This command will create an IAM policy called CodeBuddyCloudformationPolicy using the codebuddy profile. You can go to the IAM Console, click on “Add permissions”, click on “Attach existing policy”, filter policies by “Filter: Customer managed” and attach CodeBuddyCloudformationPolicy to the user. You want also to remove the previous policy IAMFullAccess that is not necessary anymore.
Now that codebuddy user is created and has all the necessary permissions you can execute the following command:
ake stack-create
This command will create an S3 bucket, an empty Lambda function and CloudWatch alarms, log group and dashboard. The good part of Cloudformation is that you can go in the console and if anything goes wrong inspect the history of events.
The S3 bucket will host our email handlebars template. In order to upload the email template (cloudformation/default.email.template.txt) you must execute:
ake update-template
Obviously the idea is that you can customize you email and re-update as you need.
Last step is to build the bundle and deploy it into Lambda, executing:
ake update-function
For the deletion, since we used Cloudformation, is as simple as executing the following command:
ake stack-delete
Be aware that most probably will fail because some resources have to be manually deleted, like alarms and the S3 bucket if it is not empty.
Use CloudWatch Console and specifically your new Dashboard to monitor your utility running on Lambda!
The default ScheduleExpression makes run this utility on daily basis, if you want to test it you can just trigger the lambda function manually. Overall I invite you to customize the lambda function for your team. You could schedule another notification at noon to invite everybody to close tasks and get ready for lunch!
Execute make help to see all the tasks ready for development.
odeBuddy [master] make help
elp
ACCOUNT ID: 000000000000
Show this help dialog.
n Clean all directories to build and distribute the project.
d Build the package code.
d-cloudformation-template Build the Cloudformation template.
Create ZIP package to deploy on AWS Lambda
tests Run test suite. Optionally accepts a grep parameter to filter only matching tests.
k-policy Create the policy to assign to codebuddy user in order to create stack in CloudFormation
k-create Create CloudFormation stack
k-delete Delete CloudFormation stack
k-update Update CloudWatch dashboard
te-function Update Lambda function with latest changes
te-template Update email template in S3