Refresh HiveGrid Cloud reference snapshot
This commit is contained in:
1 parent
5e99e14772
commit
7f88026f79
5955 files changed
+1177325
-188362
No files matched your search
@@ -1,6 +1,8 @@
|
||||
# Production Observability Runbook
|
||||
|
||||
This document is the production observability entrypoint for Production Docs diagnostics. It defines the safe surfaces operators and future agents may use to inspect health, readiness, request correlation, queues, worker failures, deployment verifier output, and redacted state without exposing raw secrets, customer data, provider payloads, tenant identifiers, or secret-shaped examples.
|
||||
This document is the production observability entrypoint. It defines the safe surfaces operators and
|
||||
agents may use to inspect health, readiness, request correlation, queues, worker failures,
|
||||
deployment verifier output and redacted state.
|
||||
|
||||
Use this runbook with [`docs/api.md`](./api.md), [`docs/deployment.md`](./deployment.md), [`docs/security.md`](./security.md), [`docs/configuration.md`](./configuration.md), and [`docs/worker.md`](./worker.md). Those documents own the detailed API, deployment, security, configuration, and worker contracts; this document explains how to observe those surfaces safely during production triage.
|
||||
|
||||
@@ -60,7 +62,9 @@ If an unsafe field appears in a shared artifact, remove the artifact from the sh
|
||||
|
||||
## Queue and job inspection
|
||||
|
||||
Worker triage may inspect queue state when a feature is queue-backed, retryable, external-provider-backed, scheduled, browser-backed, or too slow for request/response handling. Use the queue contract from `docs/worker.md` and the feature manifest before replaying or draining work.
|
||||
Worker triage may inspect queue state when a feature is queue-backed, retryable,
|
||||
external-provider-backed, scheduled, browser-backed or too slow for request/response handling. Use
|
||||
the queue contract from `docs/worker.md` and the owning ticket doc before replaying or draining work.
|
||||
|
||||
Safe queue inspection includes:
|
||||
|
||||
@@ -95,7 +99,7 @@ Deployment diagnostics are split between deterministic static proof and manual r
|
||||
|
||||
Auto-Mode-safe static evidence:
|
||||
|
||||
- `pnpm run verify:production-docs` for the production documentation contract.
|
||||
- `pnpm run verify:docs-links` for the maintained documentation graph.
|
||||
- `pnpm run verify:deploy-workflow` for the deploy workflow contract.
|
||||
- `node scripts/verify-gitea-deploy-workflow.mjs` and `node scripts/verify-gitea-ci-workflow.mjs` for static workflow PASS/FAIL output.
|
||||
- Focused verifier tests that do not launch browser automation, live Docker, registries, Coolify, provider consoles, or production traffic.
|
||||
@@ -137,8 +141,7 @@ text = Path('docs/observability.md').read_text()
|
||||
for marker in ('TO' + 'DO', 'T' + 'BD', 'FIX' + 'ME'):
|
||||
assert marker not in text
|
||||
PY
|
||||
pnpm run verify:production-docs
|
||||
pnpm exec vitest run scripts/verify-production-docs.test.mjs
|
||||
pnpm run verify:docs-links
|
||||
```
|
||||
|
||||
Live runtime checks outside the configured Gitea CI/deploy workflows are manual-only unless a human explicitly approves the exact focused run. Manual-only activities include browser flows, Playwright, Cypress, E2E checks, ad hoc live Docker builds, ad hoc registry pushes, ad hoc Coolify execution, provider-console inspection, queue replay/drain operations, and production traffic probes beyond approved health/readiness inspection. When a manual check is approved, record only non-secret command purpose, service label, status, request ID or job ID, diagnostic code, timestamp, and pass/fail result.
|
||||
|
||||
Reference in new issue
Block a user