Skip to content

docs: document iii console for trace-level inspection#157

Merged
rohitg00 merged 3 commits intomainfrom
docs/iii-console-readme
Apr 17, 2026
Merged

docs: document iii console for trace-level inspection#157
rohitg00 merged 3 commits intomainfrom
docs/iii-console-readme

Conversation

@rohitg00
Copy link
Copy Markdown
Owner

@rohitg00 rohitg00 commented Apr 17, 2026

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:

  • Install (curl -fsSL https://install.iii.dev/console/main/install.sh | sh)
  • Launch on --port 3114 to avoid port 3113 (already held by the agentmemory viewer)
  • Page-by-page guide (Functions / Triggers / States / Streams / Traces / Logs) with agentmemory-specific use cases — e.g. invoking memory.recall directly, watching a memory.search waterfall through BM25 → embeddings → reranker
  • Note that iii-config.yaml already enables the iii-observability worker with exporter: memory, sampling_ratio: 1.0, so Traces and Logs light up by default
  • Security callout — console has no built-in auth, keep it bound to 127.0.0.1

Why

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

  • Links resolve (iii.dev, install.iii.dev)
  • Nav anchor added
  • Config claims match iii-config.yaml (observability worker lines 38-46)
  • Manual: launch agentmemory + iii-console --port 3114, open http://localhost:3114, confirm Functions/Traces populate

Summary by CodeRabbit

  • Documentation
    • Added iii Console documentation describing installation, running alongside the agent, and console capabilities: direct invocation of agent actions, replay of REST-triggered workflows, KV state browsing/editing, live WebSocket stream monitoring, and OpenTelemetry trace viewing with trace_id filtering and log correlation.
    • Notes tracing is enabled by default and provides guidance to switch to OTLP export.
    • Warns the console has no auth and should be bound to 127.0.0.1.

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.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 17, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ea2760e8-759c-4b5c-897f-ef8a93a80db3

📥 Commits

Reviewing files that changed from the base of the PR and between d87cfa6 and 75c994d.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

Adds a new top-nav link and a README section titled "iii console — trace-level engine inspection" documenting installation, running the console alongside agentmemory on separate ports, console capabilities (function invocation, trigger replay, KV browsing/editing, WebSocket monitoring), OpenTelemetry trace viewing, and local-only binding.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added top-nav anchor and a new "iii console — trace-level engine inspection" section describing installation, running iii-console with agentmemory (separate ports), direct invocation of agentmemory functions, replaying REST-triggered workflows, browsing/editing iii engine KV state, monitoring iii WebSocket streams, viewing OpenTelemetry traces (including trace_id filtering and OTEL log correlation), note that tracing is enabled by default via iii-config.yaml (iii-observability worker with exporter: memory, sampling_ratio: 1.0, metrics+logs) and guidance to switch to OTLP export and bind the console to 127.0.0.1 due to lack of auth.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 I hopped to the console, ports neatly aligned,
Traces and websockets and KV I'm inclined,
I invoke and replay, then peek at each trace,
Correlated logs light the observability space,
Local-bound and grateful — a rabbit's quiet find. 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and specifically describes the main change—adding documentation for iii console trace-level inspection.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/iii-console-readme

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e9dbfa01-bf82-41ba-ab2c-35d8dc9c2bb5

📥 Commits

Reviewing files that changed from the base of the PR and between 0e8157e and ebacb20.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
rohitg00 and others added 2 commits April 17, 2026 17:31
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.
@rohitg00 rohitg00 merged commit 329e7ca into main Apr 17, 2026
2 of 3 checks passed
@rohitg00 rohitg00 deleted the docs/iii-console-readme branch April 17, 2026 16:34
rohitg00 added a commit that referenced this pull request Apr 18, 2026
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.
@rohitg00 rohitg00 mentioned this pull request Apr 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant