mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 13:51:36 +00:00
shankar0123
f7fcd1e187
Sprint 6 ACQ DEPL-006 closure follow-up. The G-3-env-docs-drift
ci-guard scans `internal/` + `cmd/` for every CERTCTL_*
env-var reference and cross-checks against README + docs/ +
deploy/helm/ + deploy/ENVIRONMENTS.md. The OTel-seed commit
(35277c0) introduced `CERTCTL_OTEL_ENABLED` in
`internal/config/config.go` + `cmd/server/main.go` but didn't
add the matching doc entry, so the guard caught the drift on
the next CI run with:
G-3 regression: env var(s) defined in Go source but never documented:
CERTCTL_OTEL_ENABLED
Replaces the existing "Tracing — explicitly not yet shipped"
subsection in docs/operator/observability.md with an honest
"Tracing — OTLP surface available, instrumentation pending"
section that:
- Documents the env var + the standard OTEL_* env vars the SDK
honors (OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_SERVICE_NAME, etc.).
- Explains the OTLP/HTTP transport choice (vs gRPC) per the
rationale in internal/observability/otel.go's header.
- Pins what the current release DOES (surface + lazy connect +
graceful shutdown) vs DOES NOT (per-handler / per-DB /
per-connector spans).
- Notes the no-op-shutdown contract so operators can defer
unconditionally.
- Cross-references the existing request_id correlation + per-
issuer Prometheus histogram as the interim correlation surface.
- Repoints the "future work" tracker from the old "v3 item"
framing to WORKSPACE-ROADMAP.md §2 (Phase 4 in the path-b
build plan).
Verified locally: `bash scripts/ci-guards/G-3-env-docs-drift.sh`
exits 0 ("G-3 env-docs-drift: clean").