README.md

English / 日本語

AWSCloudFormationTemplates/synthetics

AWSCloudFormationTemplates/synthetics builds Amazon CloudWatch Synthetics.

TL;DR

If you just want to deploy the stack, click the button below.

Architecture

The following sections describe the individual components of the architecture.

Amazon CloudWatch Synthetics

CloudWatch Synthetics creates canaries, configurable scripts that run on a schedule, and monitors your endpoints.

AWS Lambda

This template creates hearbeat scripts using AWS Lambda function that load the specified URL and store a screenshot of the page and an HTTP archive file (HAR file). They also store logs of accessed URLs.

Amazon S3

The S3 bucket stores screenshots, HAR files, and logs from the hearbeat scripts.

Amazon CloudWatch Alarm

This template creates Amazon CloudWatch custom metrics and alarms. These alarms are trigged when the success rate is less than 90%.

Deployment

Execute the command to deploy with CanaryName, DomainName and WatchedPagePath.

aws cloudformation deploy --template-file heartbeat.yaml --stack-name Synthetics --parameter-overrides CanaryName=XXXXX DomainName=XXXXX WatchedPagePath=XXXXX

You can provide optional parameters as follows.

Name	Type	Default	Required	Details
CanaryName	String		○	The name for this canary.
DomainName	String		○	The domain name that hearbeat scripts watches.
WatchedPagePath	String	/index.html	○	The page path that hearbeat scripts watches.