Using the trace-filter tool

[poldrack]

Description

I am trying to debug a Lua filter using the quarto-filter-trace.json file generated via QUARTO_TRACE_FILTERS=true. The filter trace viewer does not seem to act as suggested by the documentation (https://quarto.org/docs/troubleshooting/#debugging-lua-filters). In the latest version of quarto-cli (commit 00512ab) I see tools/trace-viewer but it's not clear how to use it; passing the input file as suggested in the outdated documentation doesn't work. Can you provide some documentation on how to run this viewer?

[cscheid]

Sorry - that documentation is in fact out of date!

Try this:

$ QUARTO_TRACE_FILTERS=output.json quarto render test.qmd
$ cd ...quarto-cli/tools/trace-viewer
$ quarto preview trace-viewer.qmd

Then, drag the .json file into the "Trace 1" or "Trace 2" text fields.

[cscheid]

I just updated the documentation as well; thanks for letting us know!

[poldrack]

Many thanks! It might also be good to add something to the rendered trace viewer page like "drag output.json file here to get started" - I had actually seen this page earlier but didn't realize I needed to drag and drop the file.

[cscheid]

That .qmd needs a lot of work (and I should know it, I wrote it). I developed it for internal use, but troubleshooting.qmd is publicly visible, so there's no excuse. We'll improve it.

[poldrack]

great, thanks! closing but feel free to reopen.