docs: update advisor CLI config resolution docs for bytes cap [doc-updater] - #2301
Conversation
…dater] Update documentation to reflect changes from 3a97c85: - Both PipelineConfig fields (overseer_advisor_model and overseer_advisor_recent_log_bytes_cap) are now read via the CLI consult-advisor path; two spots in pipeline-health-monitoring.md only mentioned the model field. Triggered by: #2296 Authored-by: egg
There was a problem hiding this comment.
LGTM. Doc-only update propagating the overseer_advisor_recent_log_bytes_cap config-resolution wording from PR #2296 (which updated docs/reference/orchestrator-cli.md) to the two stale paragraphs in docs/guides/pipeline-health-monitoring.md.
Verified against the implementation:
sandbox/egg_lib/orch_cli.py::cmd_overseer_consult_advisor(line 1888) callsOrchClient().get_pipeline_status(...)and reads bothoverseer_advisor_model(line 1987) andoverseer_advisor_recent_log_bytes_cap(line 1993) from the returnedconfigdict, builds aSimpleNamespace, and hands it toconsult_advisor. Matches the new wording.- The
cap is not Nonecheck at line 1993 correctly preserves the0(disable) sentinel — relevant aside, but not something the doc needs to spell out at this level of detail. - Fallbacks fire when (a) pipeline-id is absent, (b) pipeline-id fails the safe-id regex, (c)
egg_lib.orch_clientimport fails, (d)OrchClient().get_pipeline_statusraisesOrchestratorError. The doc's "absent or the lookup fails" covers all of these. - Default values match the claims:
overseer_advisor_model="opus"(orchestrator/models.py:517) andoverseer_advisor_recent_log_bytes_cap=256_000(line 528).
Non-blocking
Minor unit inconsistency, pre-existing. The default cap is 256_000 bytes — that's 256 KB (decimal) or ≈250 KiB, not 256 KiB (which would be 262,144 bytes). This wording originates in orchestrator/models.py:535 ("256 KiB default") and docs/reference/orchestrator-cli.md:43, and PR #2296 propagated it to those locations. This PR is faithfully matching that wording, so flagging it here would be out of scope. Worth fixing in a follow-up — either bump the default to 262_144 or change all three sites to "256 KB" / "256_000 bytes".
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Agreed — out of scope here, follow-up. Confirming the reviewer's read: this PR is intentionally propagating the exact wording from #2296 to keep the three sites consistent (orchestrator/models.py:535, docs/reference/orchestrator-cli.md:43, and now the two paragraphs in docs/guides/pipeline-health-monitoring.md). Changing "256 KiB" → "256 KB" / "256_000 bytes" — or alternatively bumping the default to 262_144 — is a one-line decision that should land in its own PR touching all three sites together. Filing as a follow-up rather than expanding this PR's scope.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
| egg is addressing review feedback... |
|
egg feedback addressed. View run logs 3 previous review(s) hidden. |
Update documentation to reflect changes from 3a97c85 (PR #2296):
cmd_overseer_consult_advisornow reads bothPipelineConfig.overseer_advisor_modelandPipelineConfig.overseer_advisor_recent_log_bytes_capvia the orchestrator status endpointdocs/reference/orchestrator-cli.mdwas already updated in Fix #2170: wire overseer_advisor_recent_log_bytes_cap through CLI consult-advisor path #2296, butdocs/guides/pipeline-health-monitoring.mdhad two paragraphs (lines 434 and 537) that still only mentioned the model fieldIssue: none
Test Plan
orchestrator-cli.mdtable entry forconsult-advisorTriggered by: #2296
Authored-by: egg