Skip to content

docs(telemetry): comprehensive documentation update to match current implementation #5960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wenshao merged 14 commits into from
Jun 28, 2026
Merged

docs(telemetry): comprehensive documentation update to match current implementation #5960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
67b804e
docs(daemon): update developer docs for recent daemon PRs
doudouOUC Jun 28, 2026
fa36d09
docs(daemon): add workspace remember design doc (PR #5884)
doudouOUC Jun 28, 2026
6956f11
docs(telemetry): comprehensive update to match current implementation
doudouOUC Jun 28, 2026
da79189
fix(telemetry): extract EVENT_TOOL_OUTPUT_TRUNCATED constant and add …
doudouOUC Jun 28, 2026
d746fa7
qwen: address PR review feedback (#5960)
doudouOUC Jun 28, 2026
c3bf39a
Merge remote-tracking branch 'origin/main' into docs/update-telemetry…
doudouOUC Jun 28, 2026
d109a2e
qwen: address PR review feedback (#5960)
doudouOUC Jun 28, 2026
4aeaec4
qwen: address PR review feedback (#5960)
doudouOUC Jun 28, 2026
a9bad96
qwen: address PR review feedback (#5960)
doudouOUC Jun 28, 2026
1bf90b3
qwen: address PR review feedback (#5960)
doudouOUC Jun 28, 2026
1286d9d
qwen: address PR review feedback (#5960)
doudouOUC Jun 28, 2026
1c7cc40
Merge remote-tracking branch 'origin/main' into docs/update-telemetry…
doudouOUC Jun 28, 2026
6a8bbd4
docs: address PR review feedback (#5960)
doudouOUC Jun 28, 2026
fab024a
docs: address PR review feedback (#5960)
doudouOUC Jun 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/developers/daemon/00-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,20 +122,20 @@ Use these anchors when moving from the docs into the latest `main` code:

### Wire protocol

| Area | Current state | Primary docs |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| HTTP routes | The route catalog lives in `qwen-serve-protocol.md`; this daemon set only references it and explains implementation ownership. | [`../qwen-serve-protocol.md`](../qwen-serve-protocol.md), [`20`](./20-quickstart-operations.md) |
| Event schema | `EVENT_SCHEMA_VERSION = 1`; 47 known event types; id-less subscriber synthetic frames; `_meta.serverTimestamp` stamped at SSE write boundary. | [`09`](./09-event-schema.md), [`10`](./10-event-bus.md) |
| Capabilities | `SERVE_PROTOCOL_VERSION = 'v1'`; 75 registered tags; 13 conditional tags. | [`11`](./11-capabilities-versioning.md) |
| Session shell | `POST /session/:id/shell` exists behind `--enable-session-shell`, bearer auth, and session-bound `X-Qwen-Client-Id`; capability tag is conditional. | [`11`](./11-capabilities-versioning.md), [`17`](./17-configuration.md), [`20`](./20-quickstart-operations.md) |
| Rate limiting | Optional per-tier HTTP rate limit is exposed by CLI flags/env and conditional capability tag. | [`11`](./11-capabilities-versioning.md), [`17`](./17-configuration.md) |
| Area | Current state | Primary docs |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| HTTP routes | The route catalog lives in `qwen-serve-protocol.md`; this daemon set only references it and explains implementation ownership. | [`../qwen-serve-protocol.md`](../qwen-serve-protocol.md), [`20`](./20-quickstart-operations.md) |
| Event schema | `EVENT_SCHEMA_VERSION = 1`; 47 known event types; id-less subscriber synthetic frames; `_meta.serverTimestamp` stamped by `EventBus.publish()` (with `formatSseFrame()` fallback for synthetic frames). | [`09`](./09-event-schema.md), [`10`](./10-event-bus.md) |
| Capabilities | `SERVE_PROTOCOL_VERSION = 'v1'`; 75 registered tags; 13 conditional tags. | [`11`](./11-capabilities-versioning.md) |
| Session shell | `POST /session/:id/shell` exists behind `--enable-session-shell`, bearer auth, and session-bound `X-Qwen-Client-Id`; capability tag is conditional. | [`11`](./11-capabilities-versioning.md), [`17`](./17-configuration.md), [`20`](./20-quickstart-operations.md) |
| Rate limiting | Optional per-tier HTTP rate limit is exposed by CLI flags/env and conditional capability tag. | [`11`](./11-capabilities-versioning.md), [`17`](./17-configuration.md) |

### Clients / SDK

| Area | Current state | Primary docs |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| TypeScript SDK daemon client | `DaemonClient`, `DaemonSessionClient`, `DaemonAuthFlow`, SSE parser, event reducers, feature preflight, and UI transcript exports are documented. | [`13`](./13-sdk-daemon-client.md) |
| Shared UI transcript layer | SDK `daemon/ui/*` normalizes daemon events into 37 UI semantic event types, reduces them into transcript blocks, and provides renderers/conformance helpers. | [`14`](./14-cli-tui-adapter.md), [`../daemon-ui/README.md`](../daemon-ui/README.md), [`../daemon-ui/MIGRATION.md`](../daemon-ui/MIGRATION.md) |
| Shared UI transcript layer | SDK `daemon/ui/*` normalizes daemon events into 42 UI semantic event types, reduces them into transcript blocks, and provides renderers/conformance helpers. | [`14`](./14-cli-tui-adapter.md), [`../daemon-ui/README.md`](../daemon-ui/README.md), [`../daemon-ui/MIGRATION.md`](../daemon-ui/MIGRATION.md) |
| Web UI daemon consumer | `packages/webui/src/daemon/` consumes the SDK transcript store through React providers and adapters. | [`14`](./14-cli-tui-adapter.md), [`../daemon-client-adapters/web-ui.md`](../daemon-client-adapters/web-ui.md) |
| CLI TUI / channels / VS Code | Legacy paths still exist; migration to shared transcript primitives is documented as follow-up work, not completed behavior. | [`14`](./14-cli-tui-adapter.md), [`15`](./15-channel-adapters.md), [`16`](./16-vscode-ide-adapter.md) |

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/daemon/13-sdk-daemon-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ auth provider when one is available.
The SDK also exports `packages/sdk-typescript/src/daemon/ui/`, a host-neutral
set of primitives that turn daemon events into transcript blocks:

- `normalizeDaemonEvent(evt)` maps the 47 known daemon wire events into 37 UI-friendly `DaemonUiEventType` values; unmodeled or malformed events normalize to `debug`.
- `normalizeDaemonEvent(evt)` maps the 47 known daemon wire events into 42 UI-friendly `DaemonUiEventType` values; unmodeled or malformed events normalize to `debug`.
- `createDaemonTranscriptState()` plus `reduceDaemonTranscriptEvents(state, events)` projects UI events into `DaemonTranscriptBlock[]`.
- `createDaemonTranscriptStore()` wraps subscribe / dispatch.
- `render.ts` / `terminal.ts` provide HTML and terminal baseline renderers, while `toolPreview.ts` produces tool-call summaries.
Expand Down
Loading
Loading