Amazon CloudWatch Construct Library
![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)
Metric objects
Metric objects represent a metric that is emitted by AWS services or your own
application, such as CPUUsage
, FailureCount
or Bandwidth
.
Metric objects can be constructed directly or are exposed by resources as
attributes. Resources that expose metrics will have functions that look
like metricXxx()
which will return a Metric object, initialized with defaults
that make sense.
For example, lambda.Function
objects have the fn.metricErrors()
method, which
represents the amount of errors reported by that Lambda function:
declare const fn: lambda.Function;
const errors = fn.metricErrors();
Metric
objects can be account and region aware. You can specify account
and region
as properties of the metric, or use the metric.attachTo(Construct)
method. metric.attachTo()
will automatically copy the region
and account
fields of the Construct
, which can come from anywhere in the Construct tree.
You can also instantiate Metric
objects to reference any
published metric
that's not exposed using a convenience method on the CDK construct.
For example:
const hostedZone = new route53.HostedZone(this, 'MyHostedZone', { zoneName: "example.org" });
const metric = new cloudwatch.Metric({
namespace: 'AWS/Route53',
metricName: 'DNSQueries',
dimensionsMap: {
HostedZoneId: hostedZone.hostedZoneId
}
});
Instantiating a new Metric object
If you want to reference a metric that is not yet exposed by an existing construct,
you can instantiate a Metric
object to represent it. For example:
const metric = new cloudwatch.Metric({
namespace: 'MyNamespace',
metricName: 'MyMetric',
dimensionsMap: {
ProcessingStep: 'Download'
}
});
Metric Math
Math expressions are supported by instantiating the MathExpression
class.
For example, a math expression that sums two other metrics looks like this:
declare const fn: lambda.Function;
const allProblems = new cloudwatch.MathExpression({
expression: "errors + throttles",
usingMetrics: {
errors: fn.metricErrors(),
faults: fn.metricThrottles(),
}
});
You can use MathExpression
objects like any other metric, including using
them in other math expressions:
declare const fn: lambda.Function;
declare const allProblems: cloudwatch.MathExpression;
const problemPercentage = new cloudwatch.MathExpression({
expression: "(problems / invocations) * 100",
usingMetrics: {
problems: allProblems,
invocations: fn.metricInvocations()
}
});
Search Expressions
Math expressions also support search expressions. For example, the following
search expression returns all CPUUtilization metrics that it finds, with the
graph showing the Average statistic with an aggregation period of 5 minutes:
const cpuUtilization = new cloudwatch.MathExpression({
expression: "SEARCH('{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"', 'Average', 300)",
label: '',
});
Cross-account and cross-region search expressions are also supported. Use
the searchAccount
and searchRegion
properties to specify the account
and/or region to evaluate the search expression against.
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
returned by CDK libraries will be configured as Average
over 300 seconds
(5 minutes).
The exception is if the metric represents a count of discrete events, such as
failures. In that case, the Metric object will be configured as Sum
over 300 seconds
, i.e. it represents the number of times that event occurred over the
time period.
If you want to change the default aggregation of the Metric object (for example,
the function or the period), you can do so by passing additional parameters
to the metric function call:
declare const fn: lambda.Function;
const minuteErrorRate = fn.metricErrors({
statistic: 'avg',
period: Duration.minutes(1),
label: 'Lambda failure rate'
});
This function also allows changing the metric label or color (which will be
useful when embedding them in graphs, see below).
Rates versus Sums
The reason for using Sum
to count discrete events is that some events are
emitted as either 0
or 1
(for example Errors
for a Lambda) and some are
only emitted as 1
(for example NumberOfMessagesPublished
for an SNS
topic).
In case 0
-metrics are emitted, it makes sense to take the Average
of this
metric: the result will be the fraction of errors over all executions.
If 0
-metrics are not emitted, the Average
will always be equal to 1
,
and not be very useful.
In order to simplify the mental model of Metric
objects, we default to
aggregating using Sum
, which will be the same for both metrics types. If you
happen to know the Metric you want to alarm on makes sense as a rate
(Average
) you can always choose to change the statistic.
Labels
Metric labels are displayed in the legend of graphs that include the metrics.
You can use dynamic labels
to show summary information about the displayed time series
in the legend. For example, if you use:
declare const fn: lambda.Function;
const minuteErrorRate = fn.metricErrors({
statistic: 'sum',
period: Duration.hours(1),
label: '[max: ${MAX}] Lambda failure rate',
});
As the metric label, the maximum value in the visible range will
be shown next to the time series name in the graph's legend.
If the metric is a math expression producing more than one time series, the
maximum will be individually calculated and shown for each time series produce
by the math expression.
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:
declare const fn: lambda.Function;
new cloudwatch.Alarm(this, 'Alarm', {
metric: fn.metricErrors(),
threshold: 100,
evaluationPeriods: 2,
});
Alternatively, you can call metric.createAlarm()
:
declare const fn: lambda.Function;
fn.metricErrors().createAlarm(this, 'Alarm', {
threshold: 100,
evaluationPeriods: 2,
});
The most important properties to set while creating an Alarms are:
threshold
: the value to compare the metric against.comparisonOperator
: the comparison operation to use, defaults to metric >= threshold
.evaluationPeriods
: how many consecutive periods the metric has to be
breaching the the threshold for the alarm to trigger.
To create a cross-account alarm, make sure you have enabled cross-account functionality in CloudWatch. Then, set the account
property in the Metric
object either manually or via the metric.attachTo()
method.
Alarm Actions
To add actions to an alarm, use the integration classes from the
@aws-cdk/aws-cloudwatch-actions
package. For example, to post a message to
an SNS topic when an alarm breaches, do the following:
import * as cw_actions from '@aws-cdk/aws-cloudwatch-actions';
declare const alarm: cloudwatch.Alarm;
const topic = new sns.Topic(this, 'Topic');
alarm.addAlarmAction(new cw_actions.SnsAction(topic));
Notification formats
Alarms can be created in one of two "formats":
- With "top-level parameters" (these are the classic style of CloudWatch Alarms).
- With a list of metrics specifications (these are the modern style of CloudWatch Alarms).
For backwards compatibility, CDK will try to create classic, top-level CloudWatch alarms
as much as possible, unless you are using features that cannot be expressed in that format.
Features that require the new-style alarm format are:
- Metric math
- Cross-account metrics
- Labels
The difference between these two does not impact the functionality of the alarm
in any way, except that the format of the notifications the Alarm generates is
different between them. This affects both the notifications sent out over SNS,
as well as the EventBridge events generated by this Alarm. If you are writing
code to consume these notifications, be sure to handle both formats.
Composite Alarms
Composite Alarms
can be created from existing Alarm resources.
declare const alarm1: cloudwatch.Alarm;
declare const alarm2: cloudwatch.Alarm;
declare const alarm3: cloudwatch.Alarm;
declare const alarm4: cloudwatch.Alarm;
const alarmRule = cloudwatch.AlarmRule.anyOf(
cloudwatch.AlarmRule.allOf(
cloudwatch.AlarmRule.anyOf(
alarm1,
cloudwatch.AlarmRule.fromAlarm(alarm2, cloudwatch.AlarmState.OK),
alarm3,
),
cloudwatch.AlarmRule.not(cloudwatch.AlarmRule.fromAlarm(alarm4, cloudwatch.AlarmState.INSUFFICIENT_DATA)),
),
cloudwatch.AlarmRule.fromBoolean(false),
);
new cloudwatch.CompositeAlarm(this, 'MyAwesomeCompositeAlarm', {
alarmRule,
});
A note on units
In CloudWatch, Metrics datums are emitted with units, such as seconds
or
bytes
. When Metric
objects are given a unit
attribute, it will be used to
filter the stream of metric datums for datums emitted using the same unit
attribute.
In particular, the unit
field is not used to rescale datums or alarm threshold
values (for example, it cannot be used to specify an alarm threshold in
Megabytes if the metric stream is being emitted as bytes).
You almost certainly don't want to specify the unit
property when creating
Metric
objects (which will retrieve all datums regardless of their unit),
unless you have very specific requirements. Note that in any case, CloudWatch
only supports filtering by unit
for Alarms, not in Dashboard graphs.
Please see the following GitHub issue for a discussion on real unit
calculations in CDK: https://github.com/aws/aws-cdk/issues/5595
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
current value of a metric, or a static piece of Markdown which explains what the
graphs mean.
The following widgets are available:
GraphWidget
-- shows any number of metrics on both the left and right
vertical axes.AlarmWidget
-- shows the graph and alarm line for a single alarm.SingleValueWidget
-- shows the current value of a set of metrics.TextWidget
-- shows some static Markdown.AlarmStatusWidget
-- shows the status of your alarms in a grid view.
Graph widget
A graph widget can display any number of metrics on either the left
or
right
vertical axis:
declare const dashboard: cloudwatch.Dashboard;
declare const executionCountMetric: cloudwatch.Metric;
declare const errorCountMetric: cloudwatch.Metric;
dashboard.addWidgets(new cloudwatch.GraphWidget({
title: "Executions vs error rate",
left: [executionCountMetric],
right: [errorCountMetric.with({
statistic: "average",
label: "Error rate",
color: cloudwatch.Color.GREEN,
})]
}));
Using the methods addLeftMetric()
and addRightMetric()
you can add metrics to a graph widget later on.
Graph widgets can also display annotations attached to the left or the right y-axis.
declare const dashboard: cloudwatch.Dashboard;
dashboard.addWidgets(new cloudwatch.GraphWidget({
leftAnnotations: [
{ value: 1800, label: Duration.minutes(30).toHumanString(), color: cloudwatch.Color.RED, },
{ value: 3600, label: '1 hour', color: '#2ca02c', }
],
}));
The graph legend can be adjusted from the default position at bottom of the widget.
declare const dashboard: cloudwatch.Dashboard;
dashboard.addWidgets(new cloudwatch.GraphWidget({
legendPosition: cloudwatch.LegendPosition.RIGHT,
}));
The graph can publish live data within the last minute that has not been fully aggregated.
declare const dashboard: cloudwatch.Dashboard;
dashboard.addWidgets(new cloudwatch.GraphWidget({
liveData: true,
}));
The graph view can be changed from default 'timeSeries' to 'bar' or 'pie'.
declare const dashboard: cloudwatch.Dashboard;
dashboard.addWidgets(new cloudwatch.GraphWidget({
view: cloudwatch.GraphWidgetView.BAR,
}));
Alarm widget
An alarm widget shows the graph and the alarm line of a single alarm:
declare const dashboard: cloudwatch.Dashboard;
declare const errorAlarm: cloudwatch.Alarm;
dashboard.addWidgets(new cloudwatch.AlarmWidget({
title: "Errors",
alarm: errorAlarm,
}));
Single value widget
A single-value widget shows the latest value of a set of metrics (as opposed
to a graph of the value over time):
declare const dashboard: cloudwatch.Dashboard;
declare const visitorCount: cloudwatch.Metric;
declare const purchaseCount: cloudwatch.Metric;
dashboard.addWidgets(new cloudwatch.SingleValueWidget({
metrics: [visitorCount, purchaseCount],
}));
Show as many digits as can fit, before rounding.
declare const dashboard: cloudwatch.Dashboard;
dashboard.addWidgets(new cloudwatch.SingleValueWidget({
metrics: [ ],
fullPrecision: true,
}));
Text widget
A text widget shows an arbitrary piece of MarkDown. Use this to add explanations
to your dashboard:
declare const dashboard: cloudwatch.Dashboard;
dashboard.addWidgets(new cloudwatch.TextWidget({
markdown: '# Key Performance Indicators'
}));
Alarm Status widget
An alarm status widget displays instantly the status of any type of alarms and gives the
ability to aggregate one or more alarms together in a small surface.
declare const dashboard: cloudwatch.Dashboard;
declare const errorAlarm: cloudwatch.Alarm;
dashboard.addWidgets(
new cloudwatch.AlarmStatusWidget({
alarms: [errorAlarm],
})
);
An alarm status widget only showing firing alarms, sorted by state and timestamp:
declare const dashboard: cloudwatch.Dashboard;
declare const errorAlarm: cloudwatch.Alarm;
dashboard.addWidgets(new cloudwatch.AlarmStatusWidget({
title: "Errors",
alarms: [errorAlarm],
sortBy: cloudwatch.AlarmStatusWidgetSortBy.STATE_UPDATED_TIMESTAMP,
states: [cloudwatch.AlarmState.ALARM],
}));
Query results widget
A LogQueryWidget
shows the results of a query from Logs Insights:
declare const dashboard: cloudwatch.Dashboard;
dashboard.addWidgets(new cloudwatch.LogQueryWidget({
logGroupNames: ['my-log-group'],
view: cloudwatch.LogQueryVisualizationType.TABLE,
queryLines: [
'fields @message',
'filter @message like /Error/',
]
}));
Custom widget
A CustomWidget
shows the result of an AWS Lambda function:
declare const dashboard: cloudwatch.Dashboard;
const fn = lambda.Function.fromFunctionArn(
dashboard,
'Function',
'arn:aws:lambda:us-east-1:123456789012:function:MyFn',
);
dashboard.addWidgets(new cloudwatch.CustomWidget({
functionArn: fn.functionArn,
title: 'My lambda baked widget',
}));
You can learn more about custom widgets in the Amazon Cloudwatch User Guide.
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,
but because this is inconvenient to do manually, the library contains a simple
layout system to help you lay out your dashboards the way you want them to.
Widgets have a width
and height
property, and they will be automatically
laid out either horizontally or vertically stacked to fill out the available
space.
Widgets are added to a Dashboard by calling add(widget1, widget2, ...)
.
Widgets given in the same call will be laid out horizontally. Widgets given
in different calls will be laid out vertically. To make more complex layouts,
you can use the following widgets to pack widgets together in different ways:
Column
: stack two or more widgets vertically.Row
: lay out two or more widgets horizontally.Spacer
: take up empty space