docs: document iii console for trace-level inspection#157
Conversation
agentmemory runs on the iii engine, so the official iii console gives users OTEL traces, the raw KV state browser, the stream monitor, and a direct function invoker for every piece of memory machinery without wiring up MCP or a custom client. - Install and launch instructions, with --port 3114 to avoid the agentmemory viewer already holding 3113. - Page-by-page guide covering Functions, Triggers, States, Streams, Traces, and Logs with agentmemory-specific use cases. - Notes that the iii-observability worker is already enabled in iii-config.yaml with exporter: memory, so Traces and Logs light up by default. - Warns that the console has no built-in auth and must stay on 127.0.0.1.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds a new top-nav link and a README section titled "iii console — trace-level engine inspection" documenting installation, running the console alongside Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 746: The README line containing the phrase "Replay HTTP triggers (the 49
REST endpoints)" is out of sync with the API section that says "107 endpoints";
update that phrase to avoid hard-coded counts—either change "the 49 REST
endpoints" to "the REST endpoints (107 total)" to match the API section or
remove the numeric count entirely (e.g., "the REST endpoints") so the doc can't
drift; search for the exact string "Replay HTTP triggers (the 49 REST
endpoints)" and the API section text "107 endpoints" to locate and update the
wording.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Add two screenshots sourced from iii.dev/docs/console and vendored into assets/iii-console/ so they don't depend on CDN signed URLs: - dashboard.png — hero shot showing counters, application flow, and registered triggers. - traces-waterfall.png — trace waterfall with per-span durations, placed above the traces setup block. states.png is checked in for a future edit but not yet referenced.
Bump version + ship CHANGELOG covering everything that merged since v0.8.13: - #118 security advisory drafts for v0.8.2 CVEs - #132 semantic eviction routing + batched retention audit - #157 iii console docs + vendored screenshots in README - #160 (#158) health gated on RSS floor - #161 (#159) standalone MCP proxies to the running server - #162 (#125) mem::forget audit coverage + policy doc - #163 (#62) @agentmemory/fs-watcher filesystem connector - #164 Next.js website (website/ root, ship to Vercel) Version bumps (8 files): - package.json / package-lock.json (top + packages['']) - plugin/.claude-plugin/plugin.json - packages/mcp/package.json (self + ~0.9.0 dep pin) - src/version.ts (union extended, assigned 0.9.0) - src/types.ts (ExportData.version union) - src/functions/export-import.ts (supportedVersions set) - test/export-import.test.ts (export assertion) Tests: 777 passing. Build clean.
Per Mike's suggestion in Slack — lots of people use agentmemory, so the README should show how to drop into the iii console for trace-level detail on memory + state.
What
New iii console subsection under Real-Time Viewer covering:
curl -fsSL https://install.iii.dev/console/main/install.sh | sh)--port 3114to avoid port 3113 (already held by the agentmemory viewer)memory.recalldirectly, watching amemory.searchwaterfall through BM25 → embeddings → rerankeriii-config.yamlalready enables theiii-observabilityworker withexporter: memory, sampling_ratio: 1.0, so Traces and Logs light up by defaultWhy
Users are landing on agentmemory first; console is a natural on-ramp into iii for the people who want to poke the engine directly.
Test plan
iii-config.yaml(observability worker lines 38-46)iii-console --port 3114, open http://localhost:3114, confirm Functions/Traces populateSummary by CodeRabbit