Skip to content

Trace Guide

Guide Maps

graph LR
  invoke["Invoke plugin action"] --> wrapper["Decorator wrapper records history"]
  wrapper --> trace["trace output"]
  trace --> tests["Runtime and CLI tests"]
flowchart LR
  question["What did the wrapper add?"] --> trace["Run or inspect the trace route"]
  trace --> config["Review configuration and recorded history"]
  config --> source["Trace back to actions.py and plugins.py"]

Use this guide when the capstone's trace output feels useful but under-interpreted. The goal is to show exactly what the wrapper contributes and what it leaves alone.

What trace proves

  • plugin configuration is visible after descriptor coercion
  • action history records which wrapped actions ran and which arguments they saw
  • wrapper behavior can stay visible without hiding the underlying plugin result
  • nested action calls, such as preview() calling deliver(), leave an ordered trail

Best shipped trace scenario

  • group: delivery
  • plugin: pager
  • action: preview
  • why it matters: it exercises nested action recording and produces a concrete JSON preview

Best companion guides