docs: node up logging flags (--log-file / --log-level / --log-json)#20
docs: node up logging flags (--log-file / --log-level / --log-json)#20willwashburn wants to merge 2 commits into
Conversation
Document the flags that surface a served node's activity — capabilities registered and actions invoked/completed/failed — in the broker-lifecycle flags table, and add a "Watch what a node is doing" section to the Nodes page with example output and the structured fields each line carries. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 55 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✨ 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.
Code Review
This pull request updates the documentation for the CLI broker lifecycle and nodes to include details about new logging flags (--log-file, --log-level, and --log-json). The review feedback suggests clarifying which structured fields are present in the text versus JSON log formats and providing a JSON log example to improve clarity.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
Preview deployed!
This is a Cloudflare Workers preview version of this PR's build. |
There was a problem hiding this comment.
All reported issues were addressed across 2 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 471f9c3e3e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Log fields are keyed to the event, not present on every line: action lines carry node/action/kind/invocationId/ms (failures add error); capability lines carry node/capability/kind. Note that --log-file/--log-json at the default info level capture actions but not the debug capability-registration lines, and align the example output (which now shows node/kind and a debug capability line). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
What
Documents the new
agent-relay node uplogging flags that surface a served fleet node's activity — every capability it registers and every action that hits it (invoked → completed/failed, with a duration). Companion to the CLI change in relay#1237.cli-broker-lifecycle.mdx— adds--log-file,--log-level,--log-jsonto thenode upflags table (and notes--verboseraises the node log level todebug), with a pointer to the Nodes page.nodes.mdx— a Watch what a node is doing section: the three invocations, the level each event logs at (capability registrationdebug, invocationsinfo, failureswarn), the structured fields every line carries (node,capability,kind,action,invocationId,ms,error), and example output.Verification
Both edited files compile cleanly with
@mdx-js/mdx; code fences balanced and table escaping matches the existing convention.Note
The documented flags ship with relay#1237 — merge/release that first (or land together) so the docs match the released CLI.
🤖 Generated with Claude Code
Summary by cubic
Adds docs for new
agent-relay node uplogging flags to watch node activity, with examples, log levels, JSON output, and event‑specific fields. Clarifies that--verboseraises node logs todebug, and that defaultinfocaptures actions but not capability registration.cli-broker-lifecycle.mdx: documents--log-file,--log-level,--log-json; notes--verbosesets node log level todebug; links to Nodes page; notes node is quiet by default.nodes.mdx: adds “Watch what a node is doing” with example commands and output; maps levels (registrationdebug, invocationsinfo, failureswarn); clarifies event‑specific fields (actions:node,action,kind,invocationId,ms,erroron failures; registration:node,capability,kind); notes defaultinfoomitsdebugregistration lines and how to include them.Written for commit c9d8b72. Summary will update on new commits.