mirror of
https://github.com/hanzoai/o11y-foundry.git
synced 2026-10-30 18:26:45 +00:00
PandeyandGitHub
08b249183f
## Summary Reshape foundryctl's output contract so it composes with agents and shell pipelines. Three changes that fall out of the same observation: **stdout, stderr, and exit codes should be a stable contract — today they're conflated.** - **Logger to stderr, silent by default.** `instrumentation.NewLogger` writes to `os.Stderr` (was `os.Stdout`) and uses `slog.DiscardHandler` unless `--debug` is set. Matches helm/aws CLI convention. stdout is now reserved for command results. - **Typed exit codes.** `internal/errors.typ` carries a `code int` field; `errors.ExitCode(err)` walks the wrap chain via `errors.As` and returns a deterministic code: `InvalidInput=2, NotFound=3, Unsupported=4, Internal=5, Fatal=6`, untyped=1, nil=0. Compact 1-6 scheme rather than sysexits.h because sysexits would collapse `Internal` and `Fatal` into the same `EX_SOFTWARE (70)`, losing a distinction we care about (Fatal = recovered panic; Internal = expected-but-failed path). `cmd/foundryctl/main.go` now exits with `errors.ExitCode(err)`. - **`fmt.Errorf` forbidden by lint.** New forbidigo rules in `.golangci.yml` ban `fmt.Errorf` and `fmt.Print*` / `print` / `println`. 168 call sites across 38 files converted to `errors.Newf` / `errors.Wrapf` with contextually-chosen types. Narrow exception for `internal/errors/error_test.go` so the ExitCode wrap-chain test stays authentic. Sites of note for review: - `internal/errors/type.go` — exit code mapping table (one source of truth) - `internal/errors/error.go` — `ExitCode(err)` helper - `internal/instrumentation/logger.go` — `slog.DiscardHandler` default - `.golangci.yml` — forbidigo config + the single narrow test exclusion ## Test plan - [x] `go build ./...` - [x] `go test ./...` (all packages pass; new `TestExitCode` covers 9 cases: nil, untyped, each typed, fmt.Errorf-wrapped, foundry-Wrapf-wrapped) - [x] `golangci-lint run ./...` — 0 issues - [x] Manual: `foundryctl forge` on a missing file exits non-zero and emits nothing on stdout (logs hidden); `--debug` emits JSON on stderr only - [x] Manual: end-to-end forge + cast against the docker/compose flavor still produces a healthy stack
82 lines
1.8 KiB
Go
82 lines
1.8 KiB
Go
package errors
|
|
|
|
import (
|
|
"encoding/json"
|
|
"log/slog"
|
|
)
|
|
|
|
type Exception struct {
|
|
Type string `json:"type,omitempty"`
|
|
Message string `json:"message"`
|
|
Cause *Exception `json:"cause,omitempty"`
|
|
Action string `json:"action,omitempty"`
|
|
Stacktrace string `json:"stacktrace,omitempty"`
|
|
}
|
|
|
|
type Envelope struct {
|
|
Exception *Exception
|
|
}
|
|
|
|
func (e Envelope) MarshalJSON() ([]byte, error) {
|
|
return json.MarshalIndent(map[string]*Exception{"exception": e.Exception}, "", " ")
|
|
}
|
|
|
|
// The walk terminates at the first non-*base link, which emits Message alone
|
|
// — stdlib wrappers format their full subtree in Error(), so re-walking them
|
|
// would duplicate that text. Stacktrace emits on TypeFatal links only; every
|
|
// *base captures one at construction time but emitting them all is noise.
|
|
func ExceptionOf(err error) *Exception {
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
|
|
b, ok := err.(*base)
|
|
if !ok {
|
|
return &Exception{Message: err.Error()}
|
|
}
|
|
|
|
e := &Exception{
|
|
Type: b.t.String(),
|
|
Message: b.info,
|
|
Action: b.t.action,
|
|
Cause: ExceptionOf(b.cause),
|
|
}
|
|
if b.t == TypeFatal && b.stacktrace != nil {
|
|
if st := b.stacktrace.String(); st != "" {
|
|
e.Stacktrace = st
|
|
}
|
|
}
|
|
|
|
return e
|
|
}
|
|
|
|
func EnvelopeOf(err error) Envelope {
|
|
return Envelope{Exception: ExceptionOf(err)}
|
|
}
|
|
|
|
func exceptionAttrs(e *Exception) []slog.Attr {
|
|
if e == nil {
|
|
return nil
|
|
}
|
|
|
|
var attrs []slog.Attr
|
|
if e.Type != "" {
|
|
attrs = append(attrs, slog.String("type", e.Type))
|
|
}
|
|
|
|
attrs = append(attrs, slog.String("message", e.Message))
|
|
if e.Cause != nil {
|
|
attrs = append(attrs, slog.GroupAttrs("cause", exceptionAttrs(e.Cause)...))
|
|
}
|
|
|
|
if e.Action != "" {
|
|
attrs = append(attrs, slog.String("action", e.Action))
|
|
}
|
|
|
|
if e.Stacktrace != "" {
|
|
attrs = append(attrs, slog.String("stacktrace", e.Stacktrace))
|
|
}
|
|
|
|
return attrs
|
|
}
|