Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Java Getting Started (+ rewrite without "cdk init") #245

Merged
merged 3 commits into from
Jul 9, 2018
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 5 additions & 13 deletions packages/@aws-cdk/cloudwatch/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
Add alarms and graphs to CDK applications
=========================================

Metric objects
--------------
## Metrics
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haha :) I had this changed in my local copy. Thanks :P


Metric objects represent a metric that is emitted by AWS services or your own
application, such as `CPUUsage`, `FailureCount` or `Bandwidth`.
Expand All @@ -19,8 +15,7 @@ represents the amount of errors reported by that Lambda function:
const errors = lambda.metricErrors();
```

Aggregation
-----------
### Aggregation

To graph or alarm on metrics you must aggregate them first, using a function
like `Average` or a percentile function like `P99`. By default, most Metric objects
Expand Down Expand Up @@ -63,8 +58,7 @@ useful when embedding them in graphs, see below).
> happen to know the Metric you want to alarm on makes sense as a rate
> (`Average`) you can always choose to change the statistic.

Alarms
------
## Alarms

Alarms can be created on metrics in one of two ways. Either create an `Alarm`
object, passing the `Metric` object to set the alarm on:
Expand Down Expand Up @@ -94,8 +88,7 @@ The most important properties to set while creating an Alarms are:
- `evaluationPeriods`: how many consecutive periods the metric has to be
breaching the the threshold for the alarm to trigger.

Making Dashboards
-----------------
## Dashboards

Dashboards are set of Widgets stored server-side which can be accessed quickly
from the AWS console. Available widgets are graphs of a metric over time, the
Expand Down Expand Up @@ -168,8 +161,7 @@ dashboard.add(new TextWidget({
}));
```

Dashboard Layout
----------------
### Dashboard Layout

The widgets on a dashboard are visually laid out in a grid that is 24 columns
wide. Normally you specify X and Y coordinates for the widgets on a Dashboard,
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/rtv/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Runtime Values
## Runtime Values

The CDK allows apps to advertise values from __construction time__ to __runtime
code__. For example, consider code in a Lambda function which needs to know the
Expand Down
Loading