Collecting logs: Web

This article will assist you in collecting logs from the Web SDK and Web RTC.

When you reach out to support, we frequently request that you provide the browser console and HAR logs to assist us in investigating the issue.

Collecting console logs

To gather the console logs:

1. Open the browser developer's tools. To do that, press F12 for Chrome/Edge/Yandex browsers, or press ⌘+Alt+C for Safari.
2. Right-click in the Console window and select Save as.

3. Save the logs for future investigation.

Collecting HAR logs

To gather the HAR logs:

1. Open the browser developer's tools. To do that, press F12 for Chrome/Edge/Yandex browsers, or press ⌘+Alt+C for Safari.
2. Select the Network tab (for all browsers).
3. Clear the existing logs by clicking the ⊘ sign for Chrome/Edge/Yandex browsers, or the trash bin sign for Safari.

4. In Chrome/Edge/Yandex, enable the Preserve log and Disable cache checkboxes.

In Safari, select the following icon and select Preserve logs.

5. Reproduce the issue.
6. In Chrome/Edge/Yandex, right-click any log and select Save all as HAR with content.

In Safari, select Export.

7. Save the logs for future investigation.

First, you have to enable logging. To do so, specify the showDebugInfo parameter while initiating an SDK instance:

Logs in Developer Console

To check the Verbose option in a Web SDK app while using it in a browser, open the developer console and select the Levels dropdown.

To view messages logged from JavaScript:

Now, reproduce your issue, right-click on the console panel, and choose "Save as…" to save the output to a file.

Do not forget to send the result file to our Support team if needed.

Logs in Browser

To view logs in the browser’s main window, use either Chrome or Firefox. Open “chrome://webrtc-internals/“ or “about:webrtc” URL accordingly.

Next, open the Web application being debugged in a new tab and reproduce the problem.

Finally, go back to the logs tab and save them as Web Page, Complete.

Log Collector

For those who want to organize logs in a special way (e.g., collect them in a database for further analysis), we've got a demo called log-collector, that is available freely on GitHub.

The demo allows you to collect logs about call state and send them to your backend server. What backend server to choose is up to you; the demo works fine with all of them since it sends POST requests and uses no black magic.

WebRTC logs are invaluable resources for developers and Voximplant technical support in troubleshooting audio and video connection issues. Currently, only Chrome and Firefox web browsers can generate these logs. This article offers a comprehensive guide on how to download them.

Chrome web browser

1. The browser tracks and logs all WebRTC connections, so close all tabs and restart the browser.
2. Open a new tab and point it to the "chrome://webrtc-internals/" URL.
3. Open the Web application being debugged and reproduce the problem.
4. Go back to the "chrome://webrtc-internals/" tab, there will be at least two tabs:
5. GetUserMedia Requests and https://your/application/url. You will see logs along with stats graphs.
6. Choose the tab with the name of your application and save the page content as Web Page, Complete.

Firefox web browser

1. Close all tabs, open a new one, and point it to the "about:webrtc" URL.
2. Open the Web application being debugged in the new tab and reproduce the problem.
3. Go back to the "about:webrtc" tab and save the page content as Web Page, Complete.

Learn how to collect logs about the state of calls and send them to your backend server using the Voximplant logs collector.

Here is how you can make the module serve your needs:

1. Clone this repo.
2. Go to the Applications section of the Voximplant control panel and click on your application.
3. Switch to the Scenarios tab and create a new scenario. Paste the code from the Scenarios.VoxEngine.js file here, then save your scenario.
4. Go to the repo folder, open logger.js, and paste your backend server hostname in line 43. Save the file.
5. Open index.html in any browser.
6. Fill in the username and password fields, e.g.: username: username@appname.account.voximplant.com password: 12345
7. Start an outgoing call or answer the incoming one.
8. When you need to send your logs, push the Report button.