Monitor the Amazon Kinesis Data Streams service with Amazon CloudWatch
Amazon Kinesis Data Streams and Amazon CloudWatch are integrated so that you can collect, view, and analyze CloudWatch
metrics for your Kinesis data streams. For example, to track shard usage, you can monitor
the IncomingBytes
and OutgoingBytes
metrics and compare them
to the number of shards in the stream.
Stream metrics and shard-level metrics that you configure are automatically collected and pushed to CloudWatch every minute. Metrics are archived for two weeks; after that period, the data is discarded.
The following table describes basic stream-level and enhanced shard-level monitoring for Kinesis data streams.
Type | Description |
---|---|
Basic (stream-level) |
Stream-level data is sent automatically every minute at no charge. |
Enhanced (shard-level) |
Shard-level data is sent every minute for an additional cost. To get this level of data, you must specifically enable it for the stream using the EnableEnhancedMonitoring operation. For information about pricing, see the Amazon CloudWatch product
page |
Amazon Kinesis Data Streams dimensions and metrics
Kinesis Data Streams sends metrics to CloudWatch at two levels: the stream level and, optionally, the shard level. Stream-level metrics are for the most common monitoring use cases in normal conditions. Shard-level metrics are for specific monitoring tasks, usually related to troubleshooting, and are enabled using the EnableEnhancedMonitoring operation.
For an explanation of the statistics gathered from CloudWatch metrics, see CloudWatch Statistics in the Amazon CloudWatch User Guide.
Topics
Basic stream-level metrics
The Amazon/Kinesis
namespace includes the following stream-level
metrics.
Kinesis Data Streams sends these stream-level metrics to CloudWatch every minute. These metrics are always available.
Metric | Description |
---|---|
GetRecords.Bytes |
The number of bytes retrieved from the Kinesis stream,
measured over the specified time period. Minimum, Maximum,
and Average statistics represent the bytes in a single
Shard-level metric name: Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Bytes |
GetRecords.IteratorAge |
This metric is no longer used. Use
|
GetRecords.IteratorAgeMilliseconds |
The age of the last record in all Shard-level metric name:
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Samples Units: Milliseconds |
GetRecords.Latency |
The time taken per Dimensions: StreamName Statistics: Minimum, Maximum, Average Units: Milliseconds |
GetRecords.Records |
The number of records retrieved from the shard, measured
over the specified time period. Minimum, Maximum, and
Average statistics represent the records in a single
Shard-level metric name:
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
GetRecords.Success |
The number of successful Dimensions: StreamName Statistics: Average, Sum, Samples Units: Count |
IncomingBytes |
The number of bytes successfully put to the Kinesis stream
over the specified time period. This metric includes bytes
from Shard-level metric name: Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Bytes |
IncomingRecords |
The number of records successfully put to the Kinesis stream
over the specified time period. This metric includes record
counts from Shard-level metric name:
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
PutRecord.Bytes |
The number of bytes put to the Kinesis stream using the
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Bytes |
PutRecord.Latency |
The time taken per Dimensions: StreamName Statistics: Minimum, Maximum, Average Units: Milliseconds |
PutRecord.Success |
The number of successful Dimensions: StreamName Statistics: Average, Sum, Samples Units: Count |
PutRecords.Bytes |
The number of bytes put to the Kinesis stream using the
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Bytes |
PutRecords.Latency |
The time taken per Dimensions: StreamName Statistics: Minimum, Maximum, Average Units: Milliseconds |
PutRecords.Records |
This metric is deprecated. Use
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
PutRecords.Success |
The number of Dimensions: StreamName Statistics: Average, Sum, Samples Units: Count |
PutRecords.TotalRecords |
The total number of records sent in a
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
PutRecords.SuccessfulRecords |
The number of successful records in a
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
PutRecords.FailedRecords |
The number of records rejected due to internal failures in
a Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
PutRecords.ThrottledRecords |
The number of records rejected due to throttling in a
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
ReadProvisionedThroughputExceeded |
The number of When the Minimum statistic has a value of 1, all records were throttled for the stream during the specified time period. When the Maximum statistic has a value of 0 (zero), no records were throttled for the stream during the specified time period. Shard-level metric name:
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
SubscribeToShard.RateExceeded |
This metric is emitted when a new subscription attempt fails because there already is an active subscription by the same consumer or if you exceed the number of calls per second allowed for this operation. Dimensions: StreamName, ConsumerName |
SubscribeToShard.Success |
This metric records whether the SubscribeToShard subscription was successfully established. The subscription only lives for at most 5 minutes. Therefore, this metric is emitted at least once every 5 minutes. Dimensions: StreamName, ConsumerName |
SubscribeToShardEvent.Bytes |
The number of bytes received from the shard, measured over the specified time period. Minimum, Maximum, and Average statistics represent the bytes published in a single event for the specified time period. Shard-level metric name: Dimensions: StreamName, ConsumerName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Bytes |
SubscribeToShardEvent.MillisBehindLatest |
The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. Dimensions: StreamName, ConsumerName Statistics: Minimum, Maximum, Average, Samples Units: Milliseconds |
SubscribeToShardEvent.Records |
The number of records received from the shard, measured over the specified time period. Minimum, Maximum, and Average statistics represent the records in a single event for the specified time period. Shard-level metric name:
Dimensions: StreamName, ConsumerName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
SubscribeToShardEvent.Success |
This metric is emitted every time an event is published
successfully. It is only emitted when there's an active
subscription. Dimensions: StreamName, ConsumerName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
WriteProvisionedThroughputExceeded |
The number of records rejected due to throttling for the
stream over the specified time period. This metric includes
throttling from When the Minimum statistic has a non-zero value, records were being throttled for the stream during the specified time period. When the Maximum statistic has a value of 0 (zero), no records were being throttled for the stream during the specified time period. Shard-level metric name:
Dimensions: StreamName Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
Enhanced shard-level metrics
The Amazon/Kinesis
namespace includes the following shard-level
metrics.
Kinesis sends the following shard-level metrics to CloudWatch every minute. Each metric
dimension creates 1 CloudWatch metric and makes approximately 43,200
PutMetricData
API calls per month. These metrics are not
enabled by default. There is a charge for enhanced metrics emitted from Kinesis.
For more information, see Amazon CloudWatch Pricing
Metric | Description |
---|---|
IncomingBytes |
The number of bytes successfully put to the shard over the
specified time period. This metric includes bytes from
Stream-level metric name:
Dimensions: StreamName, ShardId Statistics: Minimum, Maximum, Average, Sum, Samples Units: Bytes |
IncomingRecords |
The number of records successfully put to the shard over
the specified time period. This metric includes record
counts from Stream-level metric name:
Dimensions: StreamName, ShardId Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
IteratorAgeMilliseconds |
The age of the last record in all Stream-level metric name:
Dimensions: StreamName, ShardId Statistics: Minimum, Maximum, Average, Samples Units: Milliseconds |
OutgoingBytes |
The number of bytes retrieved from the shard, measured
over the specified time period. Minimum, Maximum, and
Average statistics represent the bytes returned in a single
Stream-level metric name:
Dimensions: StreamName, ShardId Statistics: Minimum, Maximum, Average, Sum, Samples Units: Bytes |
OutgoingRecords |
The number of records retrieved from the shard, measured
over the specified time period. Minimum, Maximum, and
Average statistics represent the records returned in a
single Stream-level metric name:
Dimensions: StreamName, ShardId Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
ReadProvisionedThroughputExceeded |
The number of When the Minimum statistic has a value of 1, all records were throttled for the shard during the specified time period. When the Maximum statistic has a value of 0 (zero), no records were throttled for the shard during the specified time period. Stream-level metric name:
Dimensions: StreamName, ShardId Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
WriteProvisionedThroughputExceeded |
The number of records rejected due to throttling for the
shard over the specified time period. This metric includes
throttling from When the Minimum statistic has a non-zero value, records were being throttled for the shard during the specified time period. When the Maximum statistic has a value of 0 (zero), no records were being throttled for the shard during the specified time period. Stream-level metric name:
Dimensions: StreamName, ShardId Statistics: Minimum, Maximum, Average, Sum, Samples Units: Count |
Dimensions for Amazon Kinesis Data Streams metrics
Dimension |
Description |
---|---|
StreamName
|
The name of the Kinesis stream. All available statistics are filtered by |
Recommended Amazon Kinesis Data Streams metrics
Several Amazon Kinesis Data Streams metrics might be of particular interest to Kinesis Data Streams customers. The following list provides recommended metrics and their uses.
Metric | Usage Notes |
---|---|
|
Tracks the read position across all shards and consumers in the stream. If an iterator's age passes 50% of the retention period (by default, 24 hours, configurable up to 7 days), there is risk for data loss due to record expiration. We recommend that you use CloudWatch alarms on the Maximum statistic to alert you before this loss is a risk. For an example scenario that uses this metric, see Consumer record processing is falling behind. |
|
When your consumer-side record processing is falling behind, it is sometimes difficult to know where the bottleneck is. Use this metric to determine if your reads are being throttled due to exceeding your read throughput limits. The most commonly used statistic for this metric is Average. |
WriteProvisionedThroughputExceeded |
This is for the same purpose as the
ReadProvisionedThroughputExceeded metric, but
for the producer (put) side of the stream. The most commonly
used statistic for this metric is Average. |
PutRecord.Success ,
PutRecords.Success |
We recommend using CloudWatch alarms on the Average statistic to
indicate when records are failing to the stream. Choose one or
both put types depending on what your producer uses. If using
the Kinesis Producer Library (KPL), use
PutRecords.Success . |
GetRecords.Success |
We recommend using CloudWatch alarms on the Average statistic to indicate when records are failing from the stream. |
Access Amazon CloudWatch metrics for Kinesis Data Streams
You can monitor metrics for Kinesis Data Streams using the CloudWatch console, the command line, or the CloudWatch API. The following procedures show you how to access metrics using these different methods.
To access metrics using the CloudWatch console
Open the CloudWatch console at https://console.amazonaws.cn/cloudwatch/
. -
On the navigation bar, choose a Region.
-
In the navigation pane, choose Metrics.
-
In the CloudWatch Metrics by Category pane, choose Kinesis Metrics.
-
Click the relevant row to view the statistics for the specified MetricName and StreamName.
Note: Most console statistic names match the corresponding CloudWatch metric names listed previously, except for Read Throughput and Write Throughput. These statistics are calculated over 5-minute intervals: Write Throughput monitors the
IncomingBytes
CloudWatch metric, and Read Throughput monitorsGetRecords.Bytes
. -
(Optional) In the graph pane, select a statistic and a time period, and then create a CloudWatch alarm using these settings.
To access metrics using the Amazon CLI
Use the list-metrics and get-metric-statistics commands.
To access metrics using the CloudWatch CLI
Use the mon-list-metrics and mon-get-stats commands.
To access metrics using the CloudWatch API
Use the ListMetrics and GetMetricStatistics operations.