Troubleshooting

This section provides troubleshooting tips and solutions for common issues you may encounter when using Peerix . If you are experiencing problems with your WebRTC application, check the following guides to help identify and resolve the issue.

Debugging

Peerix provides built-in verbose logging that can help you diagnose and troubleshoot issues with your WebRTC application. You can enable debug logging to get detailed information about the internal workings of the library, including signaling messages, connection states, and errors.

Peerix uses a popular logging approach. It displays debug logs in the browser console for the desired module names or patterns. This allows you to selectively enable debug logging for specific Peerix modules or namespaces, making it easier to focus on relevant information when troubleshooting.

To enable debug logging, set the debug item in localStorage to a comma-separated list of module names or patterns that you want to log. For example:

// enable debug logging for all modules
localStorage.debug = '*';

Possible patterns:

• '*': enable debug logging for all modules including third-party modules
• 'peerix:*': enable debug logging for all Peerix modules
• 'peerix:peer:*': enable debug logging for all subnamespaces under peerix:peer
• '-peerix:peer:*': disable debug logging for all subnamespaces under peerix:peer
• 'peerix:*,-peerix:peer:*': enable debug logging for all subnamespaces under peerix but disable it for all subnamespaces under peerix:peer

With debug logging enabled, you can inspect the logs in the browser console to identify any issues with your WebRTC application. Look for error messages, connection state changes, and signaling messages to help diagnose the problem.

Reporting Issues

If you encounter a bug or issue with Peerix that you cannot resolve, please report it to the Peerix team. You can create a new issue on the Peerix GitHub repository. When reporting an issue, please provide as much detail as possible, including:

• A clear description of the problem you are experiencing
• Steps to reproduce the issue
• The expected behavior and the actual behavior you are seeing
• Any relevant error messages or logs from the browser console
• The version of Peerix you are using
• The browser and operating system you are using
• A minimal code example or a link to a repository that demonstrates the issue (if possible)

This information will help the Peerix team understand and investigate the issue more effectively, and work towards providing a solution in a timely manner.