docs(synthetics): canary schedule section in README#15352
Merged
mergify[bot] merged 5 commits intoaws:masterfrom Sep 22, 2021
Merged
docs(synthetics): canary schedule section in README#15352mergify[bot] merged 5 commits intoaws:masterfrom
mergify[bot] merged 5 commits intoaws:masterfrom
Conversation
|
|
BenChaimberg
suggested changes
Jul 21, 2021
Contributor
BenChaimberg
left a comment
There was a problem hiding this comment.
thank you for improving our documentation! these are the most important contributions in my book, so sorry for the massive comment-to-changed-line ratio
|
|
||
| Configure a run rate of up to 60 minutes with `synthetics.Schedule.rate`: | ||
|
|
||
| ```js |
Contributor
There was a problem hiding this comment.
Suggested change
| ```js | |
| ```ts |
|
|
||
| If expanded access to scheduling the canary is needed, use `synthetics.Schedule.expression` with [cron expressions, as defined here](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html), for example: | ||
|
|
||
| ```js |
Contributor
There was a problem hiding this comment.
Suggested change
| ```js | |
| ```ts |
|
|
||
|
|
||
| ### Canary Schedule | ||
| You can set the canary `schedule` property by assigning it a value with the `synthetics.Schedule` [class](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-synthetics.Schedule.html). |
Contributor
There was a problem hiding this comment.
"set the canary schedule property" is not really a helpful statement, how about something like "Specify the schedule on which a canary runs by providing a Schedule value to the schedule property."?
| synthetics.Schedule.rate(Duration.minutes(5)), // Run every 5 minutes. | ||
| ``` | ||
|
|
||
| If expanded access to scheduling the canary is needed, use `synthetics.Schedule.expression` with [cron expressions, as defined here](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html), for example: |
Contributor
There was a problem hiding this comment.
Suggested change
| If expanded access to scheduling the canary is needed, use `synthetics.Schedule.expression` with [cron expressions, as defined here](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html), for example: | |
| If expanded access to scheduling the canary is needed, use `Schedule.expression` with [cron expressions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html): |
| ```js | ||
| synthetics.Schedule.expression('cron(0 0,8,16 * * ? *)'), // Run at 12am, 8am, 4pm UTC every day | ||
| ``` | ||
|
|
Contributor
There was a problem hiding this comment.
please also add a small section about once
| Configure a run rate of up to 60 minutes with `synthetics.Schedule.rate`: | ||
|
|
||
| ```js | ||
| synthetics.Schedule.rate(Duration.minutes(5)), // Run every 5 minutes. |
Contributor
There was a problem hiding this comment.
Suggested change
| synthetics.Schedule.rate(Duration.minutes(5)), // Run every 5 minutes. | |
| Schedule.rate(Duration.minutes(5)), // Run every 5 minutes. |
| ### Canary Schedule | ||
| You can set the canary `schedule` property by assigning it a value with the `synthetics.Schedule` [class](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-synthetics.Schedule.html). | ||
|
|
||
| Configure a run rate of up to 60 minutes with `synthetics.Schedule.rate`: |
Contributor
There was a problem hiding this comment.
Suggested change
| Configure a run rate of up to 60 minutes with `synthetics.Schedule.rate`: | |
| Configure a run rate of up to 60 minutes with `Schedule.rate`: |
| If expanded access to scheduling the canary is needed, use `synthetics.Schedule.expression` with [cron expressions, as defined here](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html), for example: | ||
|
|
||
| ```js | ||
| synthetics.Schedule.expression('cron(0 0,8,16 * * ? *)'), // Run at 12am, 8am, 4pm UTC every day |
Contributor
There was a problem hiding this comment.
Suggested change
| synthetics.Schedule.expression('cron(0 0,8,16 * * ? *)'), // Run at 12am, 8am, 4pm UTC every day | |
| Schedule.expression('cron(0 0,8,16 * * ? *)'), // Run at 12am, 8am, 4pm UTC every day |
kaizencc
previously approved these changes
Sep 22, 2021
Pull request has been modified.
kaizencc
approved these changes
Sep 22, 2021
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Contributor
|
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). |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
This PR adds more extensive documentation for how to schedule CloudWatch Synthetics canary cron jobs via CDK, because today the service documentation for how to schedule cron jobs is lacking and takes developers a lot of investigation to figure out how to make it work successfully.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license