Skip to content

[AAASM-4625] 📝 (python-sdk-docs): Add curl/nc liveness check to gateway note#257

Merged
Chisanan232 merged 1 commit into
masterfrom
v0.1.0/AAASM-4625/feat/gateway_note_liveness_check
Jul 15, 2026
Merged

[AAASM-4625] 📝 (python-sdk-docs): Add curl/nc liveness check to gateway note#257
Chisanan232 merged 1 commit into
masterfrom
v0.1.0/AAASM-4625/feat/gateway_note_liveness_check

Conversation

@Chisanan232

Copy link
Copy Markdown
Contributor

Stacking note

Depends on #255 (AAASM-4623) — this branch is stacked on top of it, so this diff includes #255's commit until that merges. Once #255 merges, this PR's diff will shrink to just the liveness-check addition.

Target

Extends the gateway-transports note with a tip showing how to confirm the local gateway is actually up, using standard command-line tools — requested directly by the user after reviewing #255/#280/#164.

Change

Below the existing aasm start --mode local code block, inside the same admonition:

curl http://localhost:7391/healthz   # REST — real JSON: mode, storage, version, uptime_secs
nc -z localhost 50051 && echo "gRPC port open"   # gRPC has no health endpoint yet; this only confirms the port accepts connections

Verified against the core monorepo before writing: aa-gateway/src/routes/healthz.rs defines a real, always-mounted GET /healthz returning mode/storage/version/uptime_secs JSON — not invented. No grpc.health.v1 health service is registered on the gRPC port, so nc is scoped honestly to confirming TCP reachability only, not a full protocol health check.

Validation

  • mkdocs build --strict succeeds.
  • Playwright-confirmed both commands render inside their own code block in the note.

Ticket: AAASM-4625.

REST has a real /healthz endpoint (mode/storage/version/uptime_secs);
gRPC has no health service registered yet, so nc only confirms the
port accepts connections. Lets readers confirm the local gateway is
actually up instead of guessing from SDK behavior.
@Chisanan232

Copy link
Copy Markdown
Contributor Author

Review: AAASM-4625 — gateway note liveness-check follow-up

CI: gh pr checks 257 — 3/3 passed, 0 failed.

Scope: gh pr diff 257 confirms an exact +8/-0 diff, entirely within docs/quick-start.md. Fetched the branch's file directly and confirmed the two new lines land inside the existing !!! note "Local-mode transports: :7391 REST + :50051 gRPC" admonition (4-space-indented, right after the aasm start --mode local block and before the "3. Govern your first agent" heading) — this is genuinely just the 8-line follow-up, not carrying any of PR #255's already-merged content.

Independent fact-check of the doc's claims (against agent-assembly core monorepo):

  • GET /healthz is real: aa-gateway/src/routes/healthz.rs defines HealthzBody { mode, version, storage, uptime_secs } and the handler always returns 200 OK with that JSON — matches the doc's claim verbatim. It's mounted on the REST/dashboard server (remote_mode/server.rs), which is the same port (7391) the local-mode doc's neighboring text already documents.
  • No gRPC health service exists: grepped the whole monorepo for tonic_health, HealthServer, grpc.health.v1 — zero hits, and tonic-health isn't a workspace dependency anywhere. Read through aa-gateway/src/server.rs::serve_tcp — the only services registered on the :50051 gRPC server are PolicyServiceImpl, AuditServiceImpl, TopologyServiceImpl, and the agent-lifecycle service; no health service. The nc -z-only caveat is accurate, not stale.

Regression check: git diff scope confirmed via gh pr diff (no other files touched). mkdocs build --strict passed clean in a fresh worktree off this branch — no broken links, no strict-mode errors (only the known unrelated Material-for-MkDocs 2.0 deprecation banner, not an error).

Playwright validation: Served the built site and navigated to /quick-start/. Found the new lines rendered as a proper syntax-highlighted <code> block with its own "Copy to clipboard" button, nested inside the blue note callout — not inline text. Screenshot confirms visual placement matches the existing aasm start --mode local block's styling directly above it. (Two pre-existing, unrelated 404s for versions.json in the console — a known local-dev-only artifact of the docs-versioning dropdown, not caused by this change.)

Verdict: READY — diff is clean and minimal, both technical claims in the doc are verified accurate against the current gateway source, no regressions, and the new content renders correctly in a real code block inside the callout.

— Claude Code

@Chisanan232
Chisanan232 merged commit 6e09cdd into master Jul 15, 2026
6 checks passed
@Chisanan232
Chisanan232 deleted the v0.1.0/AAASM-4625/feat/gateway_note_liveness_check branch July 15, 2026 04:19
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