Repository navigation
[Automated] Draft docs (kagent): fix(adk): default overlapSize to 0 when compactionInterval is set (+1 related) - #735
Open
github-actions[bot] wants to merge 1 commit into
Open
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…hen compactionInterval is set (+1 related) Signed-off-by: GitHub Action <action@github.com>
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
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.
The target's own content scan fails where the base build passed (docs-theme-extras
markdown-leaks/built-html-integrity):[kagent-dev/kagent#3574 and kagent-dev/kagent#3593](kagent-dev/kagent#3574 and kagent-dev/kagent#3593) — Harness compaction default and recovery telemetry
Docs versions:
mainNo code-path rule covers 1 touched file(s). The planner could route these only by identifier search, so the candidate pages may miss what they changed, including in the other mode:
python/packages/kagent-adk/src/kagent/adk/types.pyWhat changes for users: A Harness with
spec.kagent.compaction.compactionIntervaland nooverlapSizenow runs with an overlap of0instead of failing Python runtime requests. Operators also get controller telemetry for session quiescence and push delivery claims, split bykagent_worker_trigger, plus an info log when a recovery scan finds work.What the docs now say: The Metrics page now lists the new session quiescence and push delivery counters, explains the
kagent_worker_triggervalues, and gives a Prometheus query for timer-driven recovery discoveries. The compaction pages already saidoverlapSizeis optional, so #3574 needed no page edit.How
kagent-3574was draftedPlan, and what changed it
overlapSizeand document the new recovery telemetry.agents/context-management.mdandagents/declarative-agents.mdalready describeoverlapSizeas optional, and the #3574 diff restores that documented behavior;observability/metrics.mdis the page that lists controller Prometheus metrics.observability/metrics.mdfor #3593 and wrote no page change for #3574.Why a documentation change is necessary
No page change is necessary for #3574 because the existing compaction docs already tell readers that
overlapSizeis optional and only requirescompactionIntervalwhen set. The code change makes the runtime match that documented contract by defaulting the runtime overlap to0when onlycompactionIntervalis set.#3593 adds user-visible controller metrics and a recovery discovery log message. The Metrics page lists controller Prometheus metrics and example Prometheus queries, but did not mention
kagent_session_quiescence_claimed_total,kagent_push_delivery_claimed_total, or thekagent_worker_triggerlabel, so operators could not discover how to inspect recovery activity from the published docs.How to verify this change
kagent-controller-metricsjob.increase(kagent_session_quiescence_claimed_total{kagent_worker_trigger="recovery"}[1h])in Prometheus. The query shows the number of timer-driven session quiescence discoveries in the last hour.kubectl logs -n kagent deployment/kagent-controller | grep "recovery scan found work". When a recovery scan finds work, the line includesoperation,recovery_interval_seconds, and eithersession_idorregistration_id.Proposed release note
markers.notes_placeableis false for both items, so noproposed-release-note.mdwas written. Reviewer-use text:compactionIntervaland nooverlapSize; kagent now defaults the runtime overlap to0instead of letting Python ADK requests fail.kagent.worker.trigger, and recovery discoveries also write therecovery scan found workinfo log.Files in this pull request
docs-site/content/kagent/main/observability/metrics.mdHow the pages were chosen (triage report)
Feature clusters
These pull requests document one feature between them:
docs-site/content/kagent/main/agents/agent-harness.md, the only page a code-path rule names for one of them, so separate pull requests would conflictKept apart on purpose. Merging wrongly produces a guide that documents two things and explains neither, so these are reported for a person to merge rather than grouped automatically:
docs-site/content/kagent/main/agents/agent-harness.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land theredocs-site/content/kagent/main/agents/agent-harness.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land thereDraft a documentation change
kagent-dev/kagent#3574 — fix(adk): default overlapSize to 0 when compactionInterval is set
kagent-dev/websitecompactionIntervalbut nooverlapSizepasses CRD validation, but the Python runtime then fails every request: google-adk'sEventsCompactionConfigrequirescompaction_intervalandoverlap_sizetogether. The Go runtime already treats an unset overlap as 0.python/packages/kagent-adk/src/kagent/adk/types.pykagent-dev/kagent#3593 — feat(telemetry): expose session and push recovery activity
kagent-dev/websitego/core/internal/service/session/push_notifications.gogo/core/internal/service/session/quiescence.gogo/core/internal/service/session/worker_metrics.gogo/core/internal/service/session/workflow.gogo/core/pkg/app/app.gopython/packages/kagent-core/src/kagent/core/telemetry/_conv.pyDraft branch:
pr-tracker-draft-kagent-3574-plus1