> For the complete documentation index, see [llms.txt](https://docs.vdo.ninja/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vdo.ninja/advanced-settings/settings-parameters/and-debug.md).

# \&debug

Reference for the \&debug URL parameter in VDO.Ninja including behavior examples and related options.

#### **Description**

Enables verbose debug logging to browser console and optionally streams logs to a WebSocket server.

#### **General Option**

This parameter activates detailed logging for troubleshooting connection issues and debugging problems.

#### **Usage**

* **`&debug`** - Enable debug logging to console and auto-save on exit
* **`&debug=ws://server.com:port`** - Stream logs to WebSocket server
* **`&debug=wss://secure-server.com`** - Stream logs to secure WebSocket

#### **Examples**

```
https://vdo.ninja/?room=roomname&debug
https://vdo.ninja/?push=streamID&debug
https://vdo.ninja/?view=streamID&debug=ws://localhost:8080
```

#### **Details**

* Outputs verbose logs to browser's developer console
* Attempts to auto-save logs to disk when page closes
* Can stream logs in real-time to WebSocket endpoint
* Auto-save may not work in OBS browser sources
* Logs include connection states, errors, and performance data

#### **Log Contents**

* WebRTC connection states
* ICE candidate information
* Media track events
* Error messages
* Performance metrics
* Network quality data
* API calls and responses

#### **WebSocket Streaming**

When using `&debug=websocketserver`:

* Logs stream in real-time
* Requires custom WebSocket server
* Useful for remote debugging
* Can monitor multiple sessions

#### **Accessing Logs**

1. **Browser Console**: Press F12 → Console tab
2. **Auto-saved File**: Downloads on page close (Chrome only)
3. **WebSocket Stream**: Real-time on your server

#### **Use Cases**

* Troubleshooting connection failures
* Analyzing performance issues
* Remote support and debugging
* Development and testing
* Network diagnostics

#### **Notes**

* Generates significant console output
* May impact performance slightly
* Sensitive information may be logged
* Best used temporarily for troubleshooting
* Log files can become large quickly

#### **Related Parameters**

* [`&stats`](https://docs.vdo.ninja/advanced-settings/settings-parameters/and-stats.md) - Shows connection statistics overlay
* [`&showconnections`](https://docs.vdo.ninja/advanced-settings/settings-parameters/and-showconnections.md) - Displays connection info
* [`getDetailedState`](https://docs.vdo.ninja/guides/iframe-api-documentation.md) - IFRAME API command that reports connection state


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.vdo.ninja/advanced-settings/settings-parameters/and-debug.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
