Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Debug Dump

Debug Dump exports a snapshot of AZUREAL’s internal state to a text file for troubleshooting. The output contains parsing statistics, event breakdowns, rendered output samples, and recent event history – everything needed to diagnose rendering or parsing issues. Sensitive data is automatically obfuscated before writing.


Creating a Dump

Press Ctrl+D to start a debug dump. A two-phase process follows:

  1. Naming dialog – A text input appears asking for a name. Type a short identifier (e.g., “broken-render”, “missing-tool-result”) and press Enter.
  2. Dump execution – The dump runs on the next frame after the dialog closes. This ensures the dialog itself does not appear in the captured state.

The output file is saved to:

.azureal/debug-output_{name}

For example, entering “broken-render” produces .azureal/debug-output_broken-render in the project root. Entering an empty name produces .azureal/debug-output.

The name is used directly in the filename, so short hyphenated identifiers are usually the easiest to search for and share.


Contents

The dump file includes the following sections:

SectionDescription
Parsing statsCounts of parsed events by type, error rates, timing data
Event breakdownSummary of event types seen during the session
Last 5 eventsThe five most recent events in full detail
Full rendered outputThe complete rendered session pane content as it appears on screen

This gives you both the raw data (events, stats) and the visual result (rendered output) in a single file, making it straightforward to identify where parsing diverges from rendering.


Obfuscation

Debug dumps are designed to be safe to share. All sensitive content is replaced using deterministic word substitution – each unique token in the output is mapped to a replacement word, and the same token always maps to the same replacement. This means:

  • File paths, variable names, and code content are replaced with neutral words.
  • The structure of the output is fully preserved – you can still see event boundaries, nesting, formatting, and layout.
  • Tool names, event types, parsing statistics, and structural metadata are preserved verbatim, since these are needed for diagnosis.

The deterministic mapping means that if the same variable name appears in multiple places in the dump, it will have the same replacement word everywhere, so patterns and relationships remain visible even in obfuscated output.


Quick Reference

Ctrl+D        Open debug dump naming dialog
Enter         Confirm name and write dump
Esc           Cancel
DetailValue
Output path.azureal/debug-output_{name} (no extension)
Execution timingNext frame after dialog close
ObfuscationDeterministic word replacement
Preserved verbatimTool names, event types, parsing stats, structure
ReplacedFile paths, code content, variable names, user text