mirror of
https://github.com/hanzoai/o11y-foundry.git
synced 2026-11-03 02:08:34 +00:00
PandeyandGitHub
09b16ec619
## 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
64 lines
1.6 KiB
Go
64 lines
1.6 KiB
Go
package domain
|
|
|
|
import (
|
|
"maps"
|
|
|
|
"github.com/signoz/foundry/internal/errors"
|
|
)
|
|
|
|
const (
|
|
propertyKeySuccess = "success"
|
|
propertyKeyError = "error"
|
|
propertyKeyErrorType = "error_type"
|
|
propertyKeyErrorCause = "error_cause"
|
|
)
|
|
|
|
// Properties is a string-keyed bag of telemetry values with a fixed shape for
|
|
// the success/error envelope (see WithSuccess and WithError). Set, WithSuccess,
|
|
// and WithError mutate the underlying map and return the receiver for chaining.
|
|
type Properties struct {
|
|
values map[string]any
|
|
}
|
|
|
|
func NewProperties() Properties {
|
|
return Properties{values: make(map[string]any)}
|
|
}
|
|
|
|
func (p Properties) Set(key string, value any) Properties {
|
|
p.values[key] = value
|
|
return p
|
|
}
|
|
|
|
// WithSuccess records that the tracked operation succeeded.
|
|
func (p Properties) WithSuccess() Properties {
|
|
p.values[propertyKeySuccess] = true
|
|
return p
|
|
}
|
|
|
|
// WithError records the typed kind, the outer message, and the next link's
|
|
// own Message as the cause — using the link's Message (not the chained
|
|
// Error()) gives stable grouping keys for analytics.
|
|
func (p Properties) WithError(err error) Properties {
|
|
p.values[propertyKeySuccess] = false
|
|
|
|
e := errors.ExceptionOf(err)
|
|
if e == nil {
|
|
return p
|
|
}
|
|
|
|
p.values[propertyKeyErrorType] = e.Type
|
|
p.values[propertyKeyError] = e.Message
|
|
if e.Cause != nil {
|
|
p.values[propertyKeyErrorCause] = e.Cause.Message
|
|
}
|
|
|
|
return p
|
|
}
|
|
|
|
// Map returns a copy of the underlying values, safe for callers to mutate.
|
|
func (p Properties) Map() map[string]any {
|
|
out := make(map[string]any, len(p.values))
|
|
maps.Copy(out, p.values)
|
|
return out
|
|
}
|