WebRTC Voice SDKs Debug Data

warning

This is a beta feature with limited availability by SDK type. Data schema and/or presentation may change without notification.

Debug data is collected on the SDK client. It provides empirical data on the call leg between SDK client and Telnyx.

SDK	Availability
JS	Available
iOS Native	Coming soon
Android Native	Coming soon
Flutter	Coming soon

Initialize the SDK client with debug set to true and output set to socket.

When properly enabled, the SDK client will ship debug data frames to Telnyx over the websocket. The data frames are assembled into a single json file and stored in a Telnyx Cloud Storage bucket located in us-central-1 belonging to the user.

The bucket is named voice-sdk-debug-reports-[USER-ID] where USER-ID is the user's account ID.

The objects are named following this schema [call_id]/rtc_stats_reports/[segment_id] where call_id is the ID identifying the call leg between the SDK client and Telnyx. In most cases, there is only one data segment. When there is a reconnect between the SDK client and Telnyx, there may be more than one data segment.

To illustrate the above point more concretely, consider this example:

1. A call is made from a JS SDK client to a phone number.
2. The WebRTC call record is located using the detail record API.
3. Noting the call_id, locate the data using Telnyx Mission Control portal or a properly configured AWS CLI.

user@host ~ % aws s3api list-objects-v2 --bucket voice-sdk-debug-reports-22 --profile "*.telnyxstorage.com" --endpoint-url https://us-central-1.telnyxstorage.com --output table --prefix 064d6317-4837-41e2-8795-cfc304ced4d1
------------------------------------------------------------------------------------------------------------------------
|                                                     ListObjectsV2                                                    |
+---------------------------------------------------------------------------------+------------------------------------+
|  RequestCharged                                                                 |  None                              |
+---------------------------------------------------------------------------------+------------------------------------+
||                                                      Contents                                                      ||
|+--------------+-----------------------------------------------------------------------------------------------------+|
||  ETag        |  "c351226c014f9589c11b43fa47152374"                                                                 ||
||  Key         |  064d6317-4837-41e2-8795-cfc304ced4d1/rtc_stats_reports/0654064a-0f09-4b33-8f3e-66cd89941abb.json   ||
||  LastModified|  2024-12-11T17:43:25.722000+00:00                                                                   ||
||  Size        |  318313                                                                                             ||
||  StorageClass|  STANDARD                                                                                           ||
|+--------------+-----------------------------------------------------------------------------------------------------+|

where prefix is the call_id.

The data can be uploaded and visualized via https://webrtc-debug.telnyx.com/.

The next section provides addition information on how to use the data to diagnose user issues.