Skip to content

What is a Debug Bundle

Last updated:

What Is a Debug Bundle?

Section titled “What Is a Debug Bundle?”

A debug bundle is a ZIP file you can generate from the Obscura app to help us diagnose connection issues, bugs, or other problems. It collects diagnostic information about your device, network environment, and the Obscura app’s state into a single file you can share with our support team. It does not contain your browsing history or account number.

Debug bundles are never created or sent automatically. You choose when to generate one, and you control how it’s shared.

Generate a Debug Bundle

Section titled “Generate a Debug Bundle”

  1. Open the Obscura App

  2. Select the About tab on mobile or the Help tab on Desktop

  3. Click the Orange Create Debug Bundle button

  4. The file is saved locally and you choose how to share it

What’s Included

Section titled “What’s Included”
  • App configuration with sensitive fields removed (e.g. DNS settings, tunnel state, enabled features)
  • Network connectivity test results (DNS lookups, pings, HTTP checks)
  • System information (OS version, device model, hardware details)
  • Recent logs from a limited time window
  • Your description of the issue (if you entered one)

What’s Not Included

Section titled “What’s Not Included”

Debug bundles are designed to exclude sensitive data. The following are never included:

  • Account numbers
  • Authentication tokens
  • WireGuard private keys

How To Inspect Debug Bundles

Section titled “How To Inspect Debug Bundles”

Debug bundles are plain text files designed to be easy to inspect. We recommend you generate one and take a look for yourself. When you unzip the bundle, you’ll find files like:

  • info.json - app version, OS version, device model, processor, RAM, thermal state, and uptime
  • ne-debug-info.json - app configuration snapshot (cached exits/relays, DNS settings, tunnel state, enabled features)
  • system-log.json - filtered system logs (kernel messages, network extension subsystem)
  • dig-*.txt, ping-*.txt, http-*.txt - DNS lookups, ping results, and HTTP connectivity tests to public servers and the Obscura API
  • ifconfig-*.txt, netstat-*.txt - network interface and routing information
  • ne-tunnel-provider-manager.json - VPN connection status, routing method, and on-demand rules