feat(synthetics): Synthetics L2 Support #8824

kaizencc · 2020-07-01T00:21:54Z

This PR specifies an implementation for a CloudWatch Canary. It will be implemented in milestones specified below.

Closes #7687.

Currently, this PR implements up to Milestone 2.

Milestone 1: This implementation allows customers to specify a canary with these properties:

And:

generate name for users if not specified
metric methods that reference those emitted by CloudWatch

Milestone 2: This is the next step needed to allow customers to specify their own canary scripts:

test:Test
- Test class with static method Test.custom()
- Code class with static method Code.inline()
Code.fromAsset()
- validate correct folder structure for assets nodejs/node_modules
- validate correct file name
Code.fromBucket()

Milestone 3: These are features that make a more robust Canary API:

static method Test.apiEndpoint()
additional static method templates for Test
support runConfig properties - memorySize and timeout

README Rendered version

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

packages/@aws-cdk/aws-synthetics/README.md

NetaNir

I have pushed a few changes, mainly to the structure, and added a few comments inline.
A few general general comments:

Add a short section in the end which lists all of the Canary Cfn resource properties with a short description, this will give the reader a place to comment on their implementation.
Under future work you should add features/capabilities that might be implemented in the future. For example the idea of having a set of blueprints scripts for the canary code. This is a good opportunity to get feedback on ideas you might have, even if they will not be implemented in the initial version.
If there are any non trivial things you have encountered while researching the Canary resource add them under a "Note" section, readers might have ideas to how you can tackle them. Of the top pf my head - when deleting a canary it's resources, like the lambda function are not deleted.

packages/@aws-cdk/aws-synthetics/README.md

Pull request has been modified.

packages/@aws-cdk/aws-synthetics/lib/canary.ts

packages/@aws-cdk/aws-synthetics/lib/code.ts

packages/@aws-cdk/aws-synthetics/lib/schedule.ts

NetaNir · 2020-08-13T00:12:58Z

packages/@aws-cdk/aws-synthetics/test/metric.test.ts

@@ -0,0 +1,69 @@
+import '@aws-cdk/assert/jest';
+import { App, Stack } from '@aws-cdk/core';


Add a test that verifies a user can specify a custom runtime

packages/@aws-cdk/aws-synthetics/lib/canary.ts

packages/@aws-cdk/aws-synthetics/lib/test-prop.ts

packages/@aws-cdk/aws-synthetics/lib/schedule.ts

iliapolo · 2020-08-12T23:14:24Z

packages/@aws-cdk/aws-synthetics/lib/test-prop.ts

@@ -0,0 +1,121 @@
+import * as s3 from '@aws-cdk/aws-s3';


I'd actually move this entire file to canary.ts - its rather simple and avoid the clunky test-prop file name. We'll see what to do later if it grows too large.

packages/@aws-cdk/aws-synthetics/lib/code.ts

NetaNir · 2020-08-13T21:58:56Z

packages/@aws-cdk/aws-synthetics/README.md

+    //Wait for page to render.
+    //Increase or decrease wait time based on endpoint being monitored.
+    await page.waitFor(15000);
+    await synthetics.takeScreenshot('loaded', 'loaded');


Suggested change

await synthetics.takeScreenshot('loaded', 'loaded');

await synthetics.takeScreenshot('loaded', 'loaded'); // This will take a snapshot that will be included in test output artifacts

NetaNir · 2020-08-13T21:59:43Z

packages/@aws-cdk/aws-synthetics/README.md

+});
+```
+
+The following is an example of an `index.js` file which exports the `handler` function, note that the function **must** be called `handler`:


Suggested change

The following is an example of an `index.js` file which exports the `handler` function, note that the function **must** be called `handler`:

The following is an example of an `index.js` file which exports the `handler` function:

NetaNir · 2020-08-13T22:01:33Z

packages/@aws-cdk/aws-synthetics/README.md

+exports.handler = async () => {
+    return await pageLoadBlueprint();
+};
+```


here you can add a note section

> the function must be named `handler` blah blah

packages/@aws-cdk/aws-synthetics/README.md

NetaNir

Few comments on the README, also I'd prefer we bring back the "Future work" sections which includes the a link to the blueprint issues. Lets ship it!

packages/@aws-cdk/aws-synthetics/README.md

jogold · 2020-08-14T07:51:26Z

packages/@aws-cdk/aws-synthetics/README.md

+To illustrate how to use a canary, assume your application defines the following endpoint:
+
+```bash
+% curl "https://api.example.com/user/books/topbook/"
+The Hitchhikers Guide to the Galaxy
+
+```
+
+The below code defines a canary that will hit the `books/topbook` endpoint every 5 minutes: 


The example has been adapted to show how to take a screenshot. The use case is not an API anymore.

I wanted to show off the power of the synthetics library, as you mentioned in a previous comment. The heartbeat blueprint works for APIs as well, and takes a screenshot of the rendered HTML (in this case, would capture a screenshot of a white page with The Hitchhikers Guide to the Galaxy). I tested this on my own API endpoint to make sure.

While the screenshot is likely more powerful for websites, it can still be a valuable addition to APIs.

NetaNir

🦄🎉🥳

aws-cdk-automation · 2020-08-14T20:34:42Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: ab1b4e0
Result: SUCCEEDED
Build Logs (available for 30 days)

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

stale

mergify · 2020-08-14T20:50:06Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

added readme

1aaa38f

kaizencc requested a review from NetaNir July 1, 2020 00:27

kaizencc added the @aws-cdk/aws-synthetics Related to Amazon CloudWatch Synthetics label Jul 1, 2020

Kaizen Conroy and others added 2 commits June 30, 2020 20:30

lint did not like my cdk-construct banner

d98b299

Merge branch 'master' into canary-readme

69b49b3

kaizencc changed the title ~~feat(synthetics): added readme~~ chore(synthetics): added readme Jul 1, 2020

NetaNir self-assigned this Jul 1, 2020

kaizencc marked this pull request as draft July 1, 2020 15:03

kaizencc commented Jul 1, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Outdated Show resolved Hide resolved

NetaNir reviewed Jul 7, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Outdated Show resolved Hide resolved

NetaNir reviewed Jul 7, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Outdated Show resolved Hide resolved

NetaNir reviewed Jul 7, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Outdated Show resolved Hide resolved

Kaizen Conroy and others added 12 commits July 8, 2020 15:28

modified readme

4bbcb19

merge

ed4d309

Add files via upload

0fa10ff

Add files via upload

76dedc8

Delete ui-screenshot.png

7723dcb

Update README.md

3fb23bc

Update README.md

36af44b

Update README.md

473f050

Update README.md

e1b969f

Update README.md

127aff9

Update README.md

633b68e

README work

b86e280

NetaNir previously requested changes Jul 12, 2020

View reviewed changes

Update README.md

7d93681

kaizencc added 3 commits July 13, 2020 18:09

Update README.md

0e5fd2f

Delete ui-screenshot-1.png

cede1ec

Add files via upload

846ddc8

modified readme with eli's comments

867d5bb

NetaNir suggested changes Aug 13, 2020

View reviewed changes

iliapolo previously requested changes Aug 13, 2020

View reviewed changes

Kaizen Conroy added 2 commits August 13, 2020 15:43

final round of comments

3a8a7aa

minor change

458ffd9

kaizencc marked this pull request as ready for review August 13, 2020 20:16

Kaizen Conroy added 2 commits August 13, 2020 16:30

fixed iam role

0f74071

updated tests

393c561

NetaNir reviewed Aug 13, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Show resolved Hide resolved

modified readme, docs

a7c5f28

NetaNir reviewed Aug 14, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Outdated Show resolved Hide resolved

NetaNir reviewed Aug 14, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Show resolved Hide resolved

NetaNir reviewed Aug 14, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Show resolved Hide resolved

NetaNir reviewed Aug 14, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Outdated Show resolved Hide resolved

NetaNir suggested changes Aug 14, 2020

View reviewed changes

NetaNir reviewed Aug 14, 2020

View reviewed changes

packages/@aws-cdk/aws-synthetics/README.md Outdated Show resolved Hide resolved

jogold reviewed Aug 14, 2020

View reviewed changes

Kaizen Conroy added 3 commits August 14, 2020 11:34

modified readme

3c6ac95

readme changes

feca976

removed parts of future work

b4efce6

NetaNir approved these changes Aug 14, 2020

View reviewed changes

Merge branch 'master' into canary-readme

ab1b4e0

mergify bot merged commit 691b349 into aws:master Aug 14, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(synthetics): Synthetics L2 Support #8824

feat(synthetics): Synthetics L2 Support #8824

kaizencc commented Jul 1, 2020 •

edited

Loading

NetaNir left a comment

NetaNir Aug 13, 2020

iliapolo Aug 12, 2020

NetaNir Aug 13, 2020

NetaNir Aug 13, 2020

NetaNir Aug 13, 2020

NetaNir left a comment •

edited

Loading

jogold Aug 14, 2020

kaizencc Aug 14, 2020

NetaNir left a comment

aws-cdk-automation commented Aug 14, 2020

mergify bot commented Aug 14, 2020

		@@ -0,0 +1,69 @@
		import '@aws-cdk/assert/jest';
		import { App, Stack } from '@aws-cdk/core';

	await synthetics.takeScreenshot('loaded', 'loaded');
	await synthetics.takeScreenshot('loaded', 'loaded'); // This will take a snapshot that will be included in test output artifacts

	The following is an example of an `index.js` file which exports the `handler` function, note that the function must be called `handler`:
	The following is an example of an `index.js` file which exports the `handler` function:

feat(synthetics): Synthetics L2 Support #8824

feat(synthetics): Synthetics L2 Support #8824

Conversation

kaizencc commented Jul 1, 2020 • edited Loading

NetaNir left a comment

Choose a reason for hiding this comment

NetaNir Aug 13, 2020

Choose a reason for hiding this comment

iliapolo Aug 12, 2020

Choose a reason for hiding this comment

NetaNir Aug 13, 2020

Choose a reason for hiding this comment

NetaNir Aug 13, 2020

Choose a reason for hiding this comment

NetaNir Aug 13, 2020

Choose a reason for hiding this comment

NetaNir left a comment • edited Loading

Choose a reason for hiding this comment

jogold Aug 14, 2020

Choose a reason for hiding this comment

kaizencc Aug 14, 2020

Choose a reason for hiding this comment

NetaNir left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Aug 14, 2020

AWS CodeBuild CI Report

mergify bot commented Aug 14, 2020

kaizencc commented Jul 1, 2020 •

edited

Loading

NetaNir left a comment •

edited

Loading