83454e5efd
Adds internal/provlog with a single Event(name, fields) helper that emits JSON-tagged single-line records to the standard logger. Five boundary sites instrumented for #2867: provision.start — workspace_dispatchers.go (sync + async) provision.skip_existing — org_import.go idempotency hit provision.ec2_started — cp_provisioner.go after RunInstances provision.ec2_stopped — cp_provisioner.go after TerminateInstances ack restart.pre_stop — workspace_restart.go before Stop dispatch These pair with the existing human-prose log.Printf lines (kept). The new records are grep+jq friendly so a future log-aggregation pipeline can reconstruct per-workspace provision timelines without parsing the operator messages — this is the "and debug loggers so it dont happen again" half of the leak-prevention work. Tests: - provlog: emits evt-prefixed JSON, nil-tolerant, marshal-error fallback preserves event boundary, single-line output pinned. - handlers: provlog_emit_test.go pins three call-site contracts: provisionWorkspaceAutoSync emits provision.start with sync=true, stopForRestart emits restart.pre_stop with backend=cp on SaaS, and backend=none when both backends are nil. Field taxonomy is convenience for ops, not contract — payload can grow additively without breaking callers. Behavior gate is the event name + boundary location, per feedback_behavior_based_ast_gates.md. Refs #2867 (PR-D structured logging at provisioning boundaries) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
49 lines
1.8 KiB
Go
49 lines
1.8 KiB
Go
// Package provlog emits structured, single-line JSON log records for
|
|
// provisioning-lifecycle boundaries (workspace create, EC2 start/stop,
|
|
// restart, idempotency skips). Records share a stable `evt:` prefix and
|
|
// JSON payload so a future grep|jq pipeline (or a Loki/Datadog ingest)
|
|
// can reconstruct the per-workspace timeline without parsing the
|
|
// human-prose log lines that already exist.
|
|
//
|
|
// Existing log.Printf lines are intentionally NOT replaced — they
|
|
// remain the operator-facing message. Event() emits a paired structured
|
|
// record alongside, additive only.
|
|
//
|
|
// Event taxonomy (extend by appending; never rename):
|
|
//
|
|
// provision.start — workspace row inserted, EC2 about to launch
|
|
// provision.skip_existing — idempotency hit, no new EC2
|
|
// provision.ec2_started — RunInstances returned an instance id
|
|
// provision.ec2_stopped — TerminateInstances acknowledged
|
|
// restart.pre_stop — Restart handler about to call Stop
|
|
//
|
|
// Required fields per event are documented at each call site.
|
|
package provlog
|
|
|
|
import (
|
|
"encoding/json"
|
|
"log"
|
|
)
|
|
|
|
// Event writes a single line of the form:
|
|
//
|
|
// evt: <name> {"k":"v",...}
|
|
//
|
|
// to the standard logger. JSON encoding errors are silently swallowed —
|
|
// a logging helper must never panic the request path. fields may be
|
|
// nil; the empty payload `{}` is still useful to mark an event boundary.
|
|
func Event(name string, fields map[string]any) {
|
|
if fields == nil {
|
|
fields = map[string]any{}
|
|
}
|
|
payload, err := json.Marshal(fields)
|
|
if err != nil {
|
|
// Fall back to a static payload so the event boundary still
|
|
// appears in the log. The marshal error itself is recorded
|
|
// on a best-effort basis.
|
|
log.Printf("evt: %s {\"_marshal_err\":%q}", name, err.Error())
|
|
return
|
|
}
|
|
log.Printf("evt: %s %s", name, payload)
|
|
}
|