docs(agents): add observability & tracing integration guide#716
Open
joshuadarron wants to merge 5 commits intodevelopfrom
Open
docs(agents): add observability & tracing integration guide#716joshuadarron wants to merge 5 commits intodevelopfrom
joshuadarron wants to merge 5 commits intodevelopfrom
Conversation
Documents how external services consume runtime logs, lifecycle events, and pipeline traces over the WebSocket DAP channel so integrators have a single source of truth on what the server actually exposes (no OTel, Prometheus, or audit-log DB). Wires the new doc into the .rocketride/docs sync list and lists it in every agent stub (Claude Code, CLAUDE.md, AGENTS.md, Cursor, Windsurf, Copilot) so installed workspaces surface it alongside the existing README/quickstart/API references. Co-Authored-By: Claude <noreply@anthropic.com>
joshuadarron
requested review from
Rod-Christensen,
jmaionchi and
stepmikhaylov
as code owners
|
No description provided. |
Contributor
📝 WalkthroughWalkthroughAdds a RocketRide observability guide and wires it into the docs installer and multiple documentation index stubs; the installer will now include Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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. Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
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 `@docs/agents/ROCKETRIDE_OBSERVABILITY.md`:
- Around line 56-58: The fenced code block containing the single-line example
"ws://<host>:5565/task/service" is missing a language identifier which triggers
markdownlint MD040; update that fenced block by adding a language tag (for
example "text") directly after the opening triple backticks so it reads ```text
to silence the lint and preserve plain formatting.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 48153fba-c8ce-45f1-9f64-58abf38858e7
📒 Files selected for processing (8)
apps/vscode/src/agents/agent-manager.tsdocs/agents/ROCKETRIDE_OBSERVABILITY.mddocs/stubs/AGENTS.mddocs/stubs/CLAUDE.mddocs/stubs/claude-code.mddocs/stubs/copilot-instructions.mddocs/stubs/cursor.mdcdocs/stubs/windsurf.md
Adds the `text` language identifier to the WebSocket URL fenced code block so markdownlint MD040 stops flagging it, per CodeRabbit review on PR #716. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/agents/ROCKETRIDE_OBSERVABILITY.md`:
- Around line 450-453: The sentence fragment "by `(project_id, source,
startTime)`" should be folded into the previous line so the run-key guidance
reads as one clear instruction: update the `apaevt_task` → `pipeline_runs` line
to state the insert/update/reconcile behavior and then append "by `(project_id,
source, startTime)`" (e.g., "`apaevt_task` → `pipeline_runs` (insert on `begin`,
update on `end`, reconcile from `running` snapshot at startup) by `(project_id,
source, startTime)`.") Leave the following `apaevt_flow` line unchanged.
- Line 401: The docs are inconsistent: the POST /task endpoint uses query param
"trace" while the execute operation uses "pipelineTraceLevel"; update the
documentation to use a single standardized name (pick either "trace" or
"pipelineTraceLevel") across both the POST /task and execute entries or
explicitly state that they are aliases (e.g., "trace (alias:
pipelineTraceLevel)"). Locate the entries referencing POST /task and the execute
operation and make the parameter name consistent and add a short note about the
alias if you choose to support both.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: be5a159d-778d-496d-b4be-5255b104d7d0
📒 Files selected for processing (1)
docs/agents/ROCKETRIDE_OBSERVABILITY.md
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/agents/ROCKETRIDE_OBSERVABILITY.md (1)
418-421:⚠️ Potential issue | 🟡 MinorFix detached run-key fragment in ingestion mapping.
Line 420 is a sentence fragment and reads as detached guidance. Fold it into the preceding bullet so the run-key rule is unambiguous.
✏️ Proposed doc fix
- - `apaevt_task` → `pipeline_runs` (insert on `begin`, update on `end`, - reconcile from `running` snapshot at startup). - by `(project_id, source, startTime)`. + - `apaevt_task` → `pipeline_runs` (insert on `begin`, update on `end`, + reconcile from `running` snapshot at startup) keyed by + `(project_id, source, startTime)`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/agents/ROCKETRIDE_OBSERVABILITY.md` around lines 418 - 421, The second bullet is a detached fragment; merge the run-key fragment into the preceding bullet so the ingestion mapping reads as one sentence: change the two bullets describing `apaevt_task` → `pipeline_runs` and its run-key rule into a single bullet that clearly states insert on `begin`, update on `end`, reconcile from `running` snapshot at startup, and that the run-key is by `(project_id, source, startTime)`; keep the following bullet for `apaevt_flow` → `pipeline_run_traces` intact.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/agents/ROCKETRIDE_OBSERVABILITY.md`:
- Around line 418-421: The second bullet is a detached fragment; merge the
run-key fragment into the preceding bullet so the ingestion mapping reads as one
sentence: change the two bullets describing `apaevt_task` → `pipeline_runs` and
its run-key rule into a single bullet that clearly states insert on `begin`,
update on `end`, reconcile from `running` snapshot at startup, and that the
run-key is by `(project_id, source, startTime)`; keep the following bullet for
`apaevt_flow` → `pipeline_run_traces` intact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: a505586d-a682-495d-bfa2-231d82b30450
📒 Files selected for processing (1)
docs/agents/ROCKETRIDE_OBSERVABILITY.md
Collaborator
|
Heads up — your Lin/Win failures here look like the parallel-test flake on |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/agents/ROCKETRIDE_OBSERVABILITY.md— a single source of truth for how external services consume runtime logs, lifecycle events, and pipeline traces over the WebSocket DAP channel (no OpenTelemetry / Prometheus / audit-log DB exists; everything flows through/task/service).DOC_FILESinapps/vscode/src/agents/agent-manager.tsso the VS Code extension syncs it into.rocketride/docs/.claude-code.md,CLAUDE.md,AGENTS.md,cursor.mdc,windsurf.md,copilot-instructions.md) so installed workspaces see it alongside the existing README/quickstart/API references.Test plan
pnpm -C apps/vscode buildsucceeds with the updatedDOC_FILES.installAll/autoInstallagainst a fresh workspace; confirm.rocketride/docs/ROCKETRIDE_OBSERVABILITY.mdis created..claude/rules/rocketride.md,.cursor/rules/rocketride.mdc,.windsurf/rules/rocketride.md,CLAUDE.md,AGENTS.md,.github/copilot-instructions.md) lists the newROCKETRIDE_OBSERVABILITY.mdrow./task/service,authfirst-message contract,rrext_monitortypes/scopes, andpipelineTraceLevelgating ofapaevt_flow.🤖 Generated with Claude Code
Summary by CodeRabbit