Monitoring Amazon IVS with Amazon CloudWatch - Amazon Interactive Video Service

Monitoring Amazon IVS with Amazon CloudWatch

You can monitor Amazon Interactive Video Service (IVS) resources using Amazon CloudWatch. CloudWatch collects and processes raw data from Amazon IVS into readable, near real-time metrics. These statistics are kept for 15 months, so you can gain a historical perspective on how your web application or service performs. You can set alarms for certain thresholds and send notifications or take actions when those thresholds are met. For details, see the CloudWatch User Guide.

The timestamp on a metric represents the start of the period during which metric data is accumulated. For example, suppose you get a per-minute LiveDeliveredTime metric sum of 300 seconds at 01:02:00. This would mean that 5 minutes’ worth of video was served to viewers during the 1-minute period from 01:02:00 to 01:02:59.

For metrics designated as high resolution, the first data point appears several seconds after stream start. We recommend you specify a 5-second period when making the metric requests. (See Resolution in the Amazon CloudWatch User Guide.) For other metrics, data is emitted within 1 minute of the timestamp to which it refers.

The high-resolution metrics are rolled up over time. Resolution effectively decreases as the metrics age. Here is the schedule:

  • 1-second metrics are available for 3 hours.

  • 60-second metrics are available for 15 days.

  • 5-minute metrics are available for 63 days.

  • 1-hour metrics are available for 455 days (15 months).

For current information on data retention, search for "retention period" in Amazon CloudWatch FAQs.

Console Instructions

To access Amazon IVS metrics using the CloudWatch console:

  1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/.

  2. In the navigation pane, choose Metrics.

  3. On the All metrics tab, using the unlabeled dropdown at the left, select your "home" region, where your channel(s) was(were) created. For more on regions, see Global Solution, Regional Control. For a list of supported regions, see the Amazon IVS page in the AWS General Reference.

  4. If IVS appears as a selectable service under AWS Namespaces, select it. It will be listed if you use Amazon IVS and it is sending metrics to Amazon CloudWatch. (If IVS is not listed, you do not have any Amazon IVS metrics.) For example:

  5. Choose a metric dimension as desired. For available dimensions, see the Metrics table below.

For Amazon IVS Chat, the instructions are the same but the namespace is IVSChat.

CLI Instructions

You also can access the metrics using the AWS CLI. This requires that you first download and configure the CLI on your machine. For details, see the AWS Command Line Interface User Guide.

Then, to access Amazon IVS metrics using the AWS CLI:

  • At a command prompt, run:

    aws cloudwatch list-metrics --namespace AWS/IVS

For Amazon IVS Chat, specify the AWS/IVSChat namespace at the command prompt.

For more information, see Using Amazon CloudWatch Metrics in the Amazon CloudWatch User Guide.

Metrics

Amazon IVS

Amazon IVS provides the following metrics in the AWS/IVS namespace.

Metric Dimension Description

ConcurrentViews

None

A count of concurrent views across all your live channels. A view is a unique viewing session which is actively downloading or playing video. (For a more detailed definition, see the Glossary.) If channels are live but in aggregate have no views, the value of this metric is 0. If no channels are live, the metric has no data points.

Unit: Count

Valid statistics: Average, Maximum, Minimum — Average number, largest number, or smallest number (respectively) of concurrent views over the configured interval.

ConcurrentViews

Channel

Filters ConcurrentViews by channel ARN. If a channel is live but has no views, the value of this metric is 0. If a channel is not live, the metric has no data points.

This metric provides data for a channel, not a stream. To see concurrent views for a particular streaming session on a given channel, evaluate the ConcurrentViews metric for that channel between the start and end times of the streaming session.

Unit: Count

Valid statistics: Average, Maximum, Minimum — Average number, largest number, or smallest number (respectively) of concurrent views over the configured interval.

ConcurrentStreams

None

A count of your channels which are streaming live. If no channels are live, this metric has no data points.

Unit: Count

Valid statistics: Average, Maximum, Minimum — Average number, largest number, or smallest number (respectively) of concurrent streams over the configured interval.

ConcurrentStreams

Health

Filters ConcurrentStreams by channel health. If no channels are live, this metric has no data points.

Unit: Count

Valid statistics: Average, Maximum, Minimum — Average number, largest number, or smallest number (respectively) of concurrent streams for a specific Health over the configured interval.

IngestAudioBitrate

Channel

(High-resolution metric) The amount of audio data Amazon IVS receives when you stream. A higher bitrate takes up more of your available internet bandwidth.

Unit: Bits per second

Valid statistics: Average, Maximum, Minimum — Average number, largest number, or smallest number (respectively) of ingest audio bitrates over the configured interval

IngestFramerate

Channel

(High-resolution metric) How often animation frames are received by Amazon IVS when you stream.

Unit: Frames per second

Valid statistics: Average, Maximum, Minimum — Average number, largest number, or smallest number (respectively) of ingest framerates over the configured interval

IngestVideoBitrate

Channel

(High-resolution metric) The amount of video data Amazon IVS receives when you stream. A higher bitrate takes up more of your available internet bandwidth. Higher bitrate can improve video quality, but only up to a certain point.

Unit: Bits per second

Valid statistics: Average, Maximum, Minimum — Average number, largest number, or smallest number (respectively) of ingest video bitrates over the configured interval

KeyframeInterval

Channel

(High-resolution metric) The point in the video stream where the entire frame is sent instead of just the differences from the previous frame.

Unit: Seconds

Valid statistics: Average, Maximum, Minimum — Average number, largest number, or smallest number (respectively) of keyframe intervals over the configured interval

LiveDeliveredTime

None

Total real-time duration of video served to all viewers.

Unit: Seconds

Valid statistic: Sum

LiveDeliveredTime

Channel

Filters LiveDeliveredTime by channel. Channel values are the channel's resource-id, which is the last part of an ARN.

Unit: Seconds

Valid statistic: Sum

LiveDeliveredTime

Channel, ViewerCountryCode

Filters LiveDeliveredTime by channel and viewer’s country code. Channel values are the channel's resource-id, which is the last part of an ARN. Country values are two-character ISO 3166-1 country codes. This allows you to answer the question: where are my viewers watching from? If the viewer’s country cannot be determined, it is shown as UNKNOWN.

Unit: Seconds

Valid statistic: Sum

LiveInputTime

None

Real-time duration of video stream.

Unit: Seconds

Valid statistic: Sum

LiveInputTime

Channel

Filters LiveInputTime by channel. Channel values are the channel's resource-id, which is the last part of an ARN.

Unit: Seconds

Valid statistic: Sum

RecordedTime

None

Real-time duration of recorded video.

Unit: Seconds

Valid statistic: Sum

RecordedTime

Channel

Filters RecordedTime by channel. Channel values are the channel's resource-id, which is the last part of an ARN.

Unit: Seconds

Valid statistic: Sum

Amazon IVS Chat

Amazon IVS Chat provides the following metrics in the AWS/IVSChat namespace.

Metric Dimension Description

ConcurrentChatConnections

None

The total number of concurrent connections in a chat room (reported max per minute). This is useful to understand when customers approach their limit for concurrent chat connections in a region.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum

Deliveries

Action

The number of deliveries of messaging requests made of a specific action type to chat connections across all your rooms in a region.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum

InvocationErrors

Uri

The number of invocation errors of a specific message review handler across all your rooms in a region. An invocation error occurs when the message review handler cannot be invoked.

Invocation errors occur when Amazon IVS Chat cannot invoke a handler. This may happen if the handler associated with a room no longer exists or times out, or if its resource policy does not allow the service to invoke it.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum

LogDestinationAccessDeniedError

LoggingConfiguration

The number of access-denied errors of a log destination across all your rooms in a region.

These errors occur when Amazon IVS Chat cannot access the destination resource you specified in the logging configuration. This may happen if the destination resource policy does not allow the service to put records.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum

LogDestinationErrors

LoggingConfiguration

The number of all errors of a log destination across all your rooms in a region.

This is an aggregated metric which includes all types of errors that occur when Amazon IVS Chat fails to deliver logs to the destination resource you specified in the logging configuration.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum

LogDestinationResourceNotFoundErrors

LoggingConfiguration

The number of resource-not-found errors of a log destination across all your rooms in a region.

These errors occur when Amazon IVS Chat cannot deliver logs to a destination resource you specified in a logging configuration because the resource does not exist. This may happen if the destination resource associated with a logging configuration no longer exists.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum

MessagingDeliveries

None

The number of deliveries of messaging requests to chat connections across all your rooms in a region.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum

MessagingRequests

None

The number of messaging requests made across all your rooms in a region.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum

Requests

Action

The number of requests made of a specific action type across all your rooms in a region.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum

ResponseValidationErrors

Uri

The number of response-validation errors of a specific message review handler across all your rooms in a region. A response-validation error occurs when the response from the message review handler is invalid. This may mean that the response could not be parsed or fails validation checks; e.g., an invalid review result or response values that are too long.

Unit: Count

Valid statistics: Sum, Average, Maximum, Minimum