Skip to content

docs: node up logging flags (--log-file / --log-level / --log-json)#20

Open
willwashburn wants to merge 2 commits into
mainfrom
node-up-logging-docs
Open

docs: node up logging flags (--log-file / --log-level / --log-json)#20
willwashburn wants to merge 2 commits into
mainfrom
node-up-logging-docs

Conversation

@willwashburn

@willwashburn willwashburn commented Jul 8, 2026

Copy link
Copy Markdown
Member

What

Documents the new agent-relay node up logging 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-json to the node up flags table (and notes --verbose raises the node log level to debug), 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 registration debug, invocations info, failures warn), 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 up logging flags to watch node activity, with examples, log levels, JSON output, and event‑specific fields. Clarifies that --verbose raises node logs to debug, and that default info captures actions but not capability registration.

  • New Features - New features added
    • cli-broker-lifecycle.mdx: documents --log-file, --log-level, --log-json; notes --verbose sets node log level to debug; 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 (registration debug, invocations info, failures warn); clarifies event‑specific fields (actions: node, action, kind, invocationId, ms, error on failures; registration: node, capability, kind); notes default info omits debug registration lines and how to include them.

Written for commit c9d8b72. Summary will update on new commits.

Review in cubic

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>
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@willwashburn, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a0b609b0-8446-468d-86d0-3e529f007398

📥 Commits

Reviewing files that changed from the base of the PR and between d5a62c2 and c9d8b72.

📒 Files selected for processing (2)
  • web/content/docs/cli-broker-lifecycle.mdx
  • web/content/docs/nodes.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch node-up-logging-docs

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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread web/content/docs/nodes.mdx Outdated
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Preview deployed!

Environment URL
Web https://ab1c28c4-agentrelay-web.agent-workforce.workers.dev

This is a Cloudflare Workers preview version of this PR's build.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

All reported issues were addressed across 2 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread web/content/docs/nodes.mdx Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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".

Comment thread web/content/docs/nodes.mdx Outdated
Comment thread web/content/docs/nodes.mdx Outdated
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>
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