Monitoring the Amazon Chime SDK with Amazon CloudWatch
You can use CloudWatch to monitor the Amazon Chime SDK. CloudWatch collects raw data and processes it into readable, near real-time metrics. Those statistics are kept for 15 months, so that you can access historical information and gain a better perspective about how your web application or service is performing. You can also set alarms that watch for certain thresholds, and send notifications or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide.
CloudWatch metrics for the Amazon Chime SDK
The Amazon Chime SDK sends the following metrics to CloudWatch The Amazon Chime SDK sends the metrics once per minute for the duration of a call, and it sends all of the metrics listed here.
The AWS/ChimeVoiceConnector namespace includes the following metrics
for phone numbers assigned to your AWS account, and to Amazon Chime SDK Voice Connectors.
Note
The SDK sends packet-loss values once per minute for the duration of a call. The loss values accumulate for the duration of the call. For example, if a packet loss occurs at 11:01, that loss value carries forward for the remaining minutes of the call. At the end of the call, you receive a single packet-loss metric.
| Metric | Description |
|---|---|
|
|
The number of inbound calls attempted. Units: Count |
|
|
The number of inbound call failures. Units: Count |
|
|
The number of inbound calls that are answered. Units: Count |
|
|
The number of inbound calls that are currently active. Units: Count |
|
|
The number of outbound calls attempted. Units: Count |
|
|
The number of outbound call failures. Units: Count |
|
|
The number of outbound calls that are answered. Units: Count |
|
|
The number of outbound calls that are currently active. Units: Count |
|
|
The number of times your account is throttled when attempting to make a call. Units: Count |
|
|
The number of SIP messages with 1xx-level status codes. Units: Count |
|
|
The number of SIP messages with 2xx-level status codes. Units: Count |
|
|
The number of SIP messages with 3xx-level status codes. Units: Count |
|
|
The number of SIP messages with 4xx-level status codes. Units: Count |
|
|
The number of SIP messages with 5xx-level status codes. Units: Count |
|
|
The number of SIP messages with 6xx-level status codes. Units: Count |
|
|
The number of RTP packets sent from the customer to the Amazon Chime SDK Voice Connector infrastructure. Units: Count |
|
|
The number of bytes sent from the customer to the Amazon Chime SDK Voice Connector infrastructure in RTP packets. Units: Count |
|
|
The number of RTCP packets sent from the customer to the Amazon Chime SDK Voice Connector infrastructure. Units: Count |
|
|
The number of bytes sent from the customer to the Amazon Chime SDK Voice Connector infrastructure in RTCP packets. Units: Count |
|
|
The number of packets lost in transit from the customer to the Amazon Chime SDK Voice Connector infrastructure. Values are sent every minute until the call ends. The value count is cumulative. Units: Count |
|
|
The average jitter for packets sent from the customer to the Amazon Chime SDK Voice Connector infrastructure. Units: Microseconds |
|
|
The number of RTP packets sent from the Amazon Chime SDK Voice Connector infrastructure to the customer. Units: Count |
|
|
The number of bytes sent from the Amazon Chime SDK Voice Connector infrastructure to the customer in RTP packets. Units: Count |
|
|
The number of RTCP packets sent from the Amazon Chime SDK Voice Connector infrastructure to the customer. Units: Count |
|
|
The number of bytes sent from the Amazon Chime SDK Voice Connector infrastructure to the customer in RTCP packets. Units: Count |
|
|
The number of packets lost in transit from the Amazon Chime SDK Voice Connector infrastructure to the customer. Values are sent every minute until the call ends. The value count is cumulative. Units: Count |
|
|
The average jitter for packets sent from the Amazon Chime SDK Voice Connector infrastructure to the customer. Units: Microseconds |
|
|
The average round-trip time between the customer and the Amazon Chime SDK Voice Connector infrastructure. Units: Microseconds |
|
|
The estimated Mean opinion score (MOS) associated with voice streams between the customer and the Amazon Chime SDK Voice Connector infrastructure. Units: Score between 1.0-4.4. A higher score indicates better perceived audio quality. |
|
|
The number of RTP packets sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure. Units: Count |
|
|
The number of bytes sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure in RTP packets. Units: Count |
|
|
The number of RTCP packets sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure. Units: Count |
|
|
The number of bytes sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure in RTCP packets. Units: Count |
|
|
The number of packets lost in transit from the remote end to the Amazon Chime SDK Voice Connector infrastructure. Values are sent every minute until the call ends. The value count is cumulative. Units: Count |
|
|
The average jitter for packets sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure. Units: Microseconds |
|
|
The number of RTP packets sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end. Units: Count |
|
|
The number of bytes sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end in RTP packets. Units: Count |
|
|
The number of RTCP packets sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end. Units: Count |
|
|
The number of bytes sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end in RTCP packets. Units: Count |
|
|
The number of packets lost in transit from the Amazon Chime SDK Voice Connector infrastructure to the remote end. Values are sent every minute until the call ends. The value count is cumulative. Units: Count |
|
|
The average jitter for packets sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end. Units: Microseconds |
|
|
The average round-trip time between the remote end and the Amazon Chime SDK Voice Connector infrastructure. Units: Microseconds |
|
|
The estimated Mean opinion score (MOS) associated with voice streams between the remote end and the Amazon Chime SDK Voice Connector infrastructure. Units: Units: Score between 1.0-4.4. A higher score indicates better perceived audio quality. |
CloudWatch dimensions for the Amazon Chime SDK
The CloudWatch dimensions that you can use with the Amazon Chime SDK are listed as follows.
| Dimension | Description |
|---|---|
|
|
The identifier of the Amazon Chime SDK Voice Connector to display metrics for. |
|
|
The AWS Region associated with the event. |
CloudWatch logs for the Amazon Chime SDK
You can configure your Amazon Chime SDK Voice Connectors to send metrics to CloudWatch Logs. When you do, you can also receive media-quality metric logs for those Voice Connectors.
The Amazon Chime SDK sends detailed metrics once per minute. The Amazon Chime SDK sends them for all the calls made with the configured Voice Connectors, and it sends them to a CloudWatch Logs log group that we create for you.
The log group name uses this format: /aws/ChimeVoiceConnectorLogs/${.VoiceConnectorID}
For more information about configuring Voice Connectors to send metrics, see Editing Amazon Chime SDK Voice Connector settings.
Note
Packet loss metrics accumulate for the duration of a call. For example, if a packet loss occurs at 11:01, that loss value carries forward for the remaining minutes of the call. At the end of the call, you receive a single packet-loss metric.
The Amazon Chime SDK includes the following fields in the logs, in JSON format.
| Field | Description |
|---|---|
|
voice_connector_id |
The Amazon Chime SDK Voice Connector ID carrying the call. |
|
event_timestamp |
The time when the metrics are emitted, in number of milliseconds since the UNIX epoch (midnight on January 1, 1970) in UTC. |
|
call_id |
Corresponds to the Transaction ID. |
|
from_sip_user |
The initiating user for the call. |
|
from_country |
The initiating country for the call. |
|
to_sip_user |
The receiving user for the call. |
|
to_country |
The receiving country for the call. |
|
endpoint_id |
An opaque identifier indicating the other endpoint of the call. Use with CloudWatch Logs Insights. For more information, see Analyzing log data with CloudWatch Logs Insights in the Amazon CloudWatch Logs User Guide. |
|
aws_region |
The AWS Region for the call. |
|
cust2vc_rtp_packets |
The number of RTP packets sent from the customer to the Amazon Chime SDK Voice Connector infrastructure. |
|
cust2vc_rtp_bytes |
The number of bytes sent from the customer to the Amazon Chime SDK Voice Connector infrastructure in RTP packets. |
|
cust2vc_rtcp_packets |
The number of RTCP packets sent from the customer to the Amazon Chime SDK Voice Connector infrastructure. |
|
cust2vc_rtcp_bytes |
The number of bytes sent from the customer to the Amazon Chime SDK Voice Connector infrastructure in RTCP packets. |
|
cust2vc_packets_lost |
The number of packets lost in transit from the customer to the Amazon Chime SDK Voice Connector infrastructure. Values are sent every minute until the call ends. The value count is cumulative. |
|
cust2vc_jitter |
The average jitter for packets sent from the customer to the Amazon Chime SDK Voice Connector infrastructure. |
|
vc2cust_rtp_packets |
The number of RTP packets sent from the Amazon Chime SDK Voice Connector infrastructure to the customer. |
|
vc2cust_rtp_bytes |
The number of bytes sent from the Amazon Chime SDK Voice Connector infrastructure to the customer in RTP packets. |
|
vc2cust_rtcp_packets |
The number of RTCP packets sent from the Amazon Chime SDK Voice Connector infrastructure to the customer. |
|
vc2cust_rtcp_bytes |
The number of bytes sent from the Amazon Chime SDK Voice Connector infrastructure to the customer in RTCP packets. |
|
vc2cust_packets_lost |
The number of packets lost in transit from the Amazon Chime SDK Voice Connector infrastructure to the customer. Values are sent every minute until the call ends. The value count is cumulative. |
|
vc2cust_jitter |
The average jitter for packets sent from the Amazon Chime SDK Voice Connector infrastructure to the customer. |
|
rtt_btwn_vc_and_cust |
The average round-trip time between the customer and the Amazon Chime SDK Voice Connector infrastructure. |
|
mos_btwn_vc_and_cust |
The estimated Mean opinion score (MOS) associated with voice streams between the customer and the Amazon Chime SDK Voice Connector infrastructure. |
|
rem2vc_rtp_packets |
The number of RTP packets sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure. |
|
rem2vc_rtp_bytes |
The number of bytes sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure in RTP packets. |
|
rem2vc_rtcp_packets |
The number of RTCP packets sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure. |
|
rem2vc_rtcp_bytes |
The number of bytes sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure in RTCP packets. |
|
rem2vc_packets_lost |
The number of packets lost in transit from the remote end to the Amazon Chime SDK Voice Connector infrastructure. Values are sent every minute until the call ends. The value count is cumulative. |
|
rem2vc_jitter |
The average jitter for packets sent from the remote end to the Amazon Chime SDK Voice Connector infrastructure. |
|
vc2rem_rtp_packets |
The number of RTP packets sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end. |
|
vc2rem_rtp_bytes |
The number of bytes sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end in RTP packets. |
|
vc2rem_rtcp_packets |
The number of RTCP packets sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end. |
|
vc2rem_rtcp_bytes |
The number of bytes sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end in RTCP packets. |
|
vc2rem_packets_lost |
The number of packets lost in transit from the Amazon Chime SDK Voice Connector infrastructure to the remote end. Values are sent every minute until the call ends. The value count is cumulative. |
|
vc2rem_jitter |
The average jitter for packets sent from the Amazon Chime SDK Voice Connector infrastructure to the remote end. |
|
rtt_btwn_vc_and_rem |
The average round-trip time between the remote end and the Amazon Chime SDK Voice Connector infrastructure. |
|
mos_btwn_vc_and_rem |
The estimated Mean opinion score (MOS) associated with voice streams between the remote end and the Amazon Chime SDK Voice Connector infrastructure. |
SIP message logs
You can opt to receive SIP message logs for your Amazon Chime SDK Voice Connector. When you do, the
Amazon Chime SDK captures inbound and outbound SIP messages and sends them to a CloudWatch Logs log
group that is created for you. The log group name is
/aws/ChimeVoiceConnectorSipMessages/${.
The following fields are included in the logs, in JSON format.VoiceConnectorID}
| Field | Description |
|---|---|
|
voice_connector_id |
The Amazon Chime SDK Voice Connector ID. |
|
aws_region |
The AWS Region associated with the event. |
|
event_timestamp |
The time when the message is captured, in number of milliseconds since the UNIX epoch (midnight on January 1, 1970) in UTC. |
|
call_id |
The Amazon Chime SDK Voice Connector call ID. |
|
sip_message |
The full SIP message that is captured. |
