
Structured Error Handling
FreeEnhance error management in Golang applications.
Free · Opens the source repo
What Structured Error Handling does
The samber/oops skill provides a structured approach to error handling in Go, allowing developers to treat errors as first-class citizens with rich context. Unlike standard Go error handling, which often lacks sufficient detail for effective debugging, samber/oops enables the inclusion of domain-specific attributes, stack traces, and user-friendly messages. This skill is particularly useful for engineers who want to improve the observability of their applications and ensure that errors carry meaningful information throughout the call stack.
By integrating structured context into errors, developers can easily track down issues without needing to ask for additional information from the original developer. The fluent builder pattern allows for a clear and concise way to create errors, encapsulating relevant data such as user identifiers, request details, and service domains. This not only aids in debugging but also improves collaboration among team members, as the context is preserved and easily accessible.
The skill is designed for Go engineers who are already using or planning to adopt the samber/oops library. It is beneficial in various scenarios, including database interactions, HTTP request handling, and service layer operations. The ability to attach custom attributes and categorize errors with tags enhances the capability of application performance monitoring (APM) tools to group and analyze errors effectively.
Overall, this skill is a valuable addition for any Go developer looking to implement a more robust error handling strategy. It allows for better diagnostics and improves the maintainability of codebases by ensuring that errors are informative and actionable.
When to use it
Use this skill when implementing error handling in Go applications, especially when using the samber/oops library.
When not to use it
This skill is not suitable for projects that do not utilize the samber/oops library or for simple applications where standard error handling suffices.
What you can build with it
Database Error Handling
Utilize structured error handling in database interactions to capture relevant query details and user context.
HTTP Request Management
Implement user-friendly error messages in HTTP handlers to enhance client communication during failures.
Service Layer Operations
Create reusable error builders in service layers to maintain consistent error handling across different operations.
How to install Structured Error Handling
View source1. Install with the skills CLI
npx skills add samber/cc-skills-golang/golang-samber-oops --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by samberPersona: You are a Go engineer who treats errors as structured data. Every error carries enough context — domain, attributes, trace — for an on-call engineer to diagnose the problem without asking the developer.
samber/oops Structured Error Handling
samber/oops is a drop-in replacement for Go's standard error handling that adds structured context, stack traces, error codes, public messages, and panic recovery. Variable data goes in .With() attributes (not the message string), so APM tools (Datadog, Loki, Sentry) can group errors properly. Unlike the stdlib approach (adding slog attributes at the log site), oops attributes travel with the error through the call stack.
Why use samber/oops
Standard Go errors lack context — you see connection failed but not which user triggered it, what query was running, or the full call stack. samber/oops provides:
- Structured context — key-value attributes on any error
- Stack traces — automatic call stack capture
- Error codes — machine-readable identifiers
- Public messages — user-safe messages separate from technical details
- Low-cardinality messages — variable data in
.With()attributes, not the message string, so APM tools group errors properly
This skill is not exhaustive. Please refer to library documentation and code examples for more information. For Go package docs, symbols, versions, importers, and known vulnerabilities, → See samber/cc-skills-golang@golang-pkg-go-dev skill (godig) — prefer it over Context7 for Go package facts. To navigate this library's usage in your own code (definitions, call sites, diagnostics), → See samber/cc-skills-golang@golang-gopls skill (gopls). Context7 remains a fallback for docs not indexed on pkg.go.dev.
Core pattern: Error builder chain
All oops errors use a fluent builder pattern:
err := oops.
In("user-service"). // domain/feature
Tags("database", "postgres"). // categorization
Code("network_failure"). // machine-readable identifier
User("user-123", "email", "foo@bar.com"). // user context
With("query", query). // custom attributes
Errorf("failed to fetch user: %s", "timeout")
Terminal methods:
.Errorf(format, args...)— create a new error.Wrap(err)— wrap an existing error.Wrapf(err, format, args...)— wrap with a message.Join(err1, err2, ...)— combine multiple errors.Recover(fn)/.Recoverf(fn, format, args...)— convert panic to error
Error builder methods
| Methods | Use case |
|---|---|
.With("key", value) | Add custom key-value attribute (lazy func() any values supported) |
.WithContext(ctx, "key1", "key2") | Extract values from Go context into attributes (lazy values supported) |
.In("domain") | Set the feature/service/domain |
.Tags("auth", "sql") | Add categorization tags (query with err.HasTag("tag")) |
.Code("iam_authz_missing_permission") | Set machine-readable error identifier/slug |
.Public("Could not fetch user.") | Set user-safe message (separate from technical details) |
.Hint("Runbook: https://doc.acme.org/doc/abcd.md") | Add debugging hint for developers |
.Owner("team/slack") | Identify responsible team/owner |
.User(id, "k", "v") | Add user identifier and attributes |
.Tenant(id, "k", "v") | Add tenant/organization context and attributes |
.Trace(id) | Add trace / correlation ID (default: ULID) |
.Span(id) | Add span ID representing a unit of work/operation (default: ULID) |
.Time(t) | Override error timestamp (default: time.Now()) |
.Since(t) | Set duration based on time since t (exposed via err.Duration()) |
.Duration(d) | Set explicit error duration |
.Request(req, includeBody) | Attach *http.Request (optionally including body) |
.Response(res, includeBody) | Attach *http.Response (optionally including body) |
oops.FromContext(ctx) | Start from an OopsErrorBuilder stored in a Go context |
Common scenarios
Database/repository layer
func (r *UserRepository) FetchUser(id string) (*User, error) {
query := "SELECT * FROM users WHERE id = $1"
row, err := r.db.Query(query, id)
if err != nil {
return nil, oops.
In("user-repository").
Tags("database", "postgres").
With("query", query).
With("user_id", id).
Wrapf(err, "failed to fetch user from database")
}
// ...
}
HTTP handler layer
func (h *Handler) CreateUser(w http.ResponseWriter, r *http.Request) {
userID := getUserID(r)
err := h.service.CreateUser(r.Context(), userID)
if err != nil {
err = oops.
In("http-handler").
Tags("endpoint", "/users").
Request(r, false).
User(userID).
Wrapf(err, "create user failed")
http.Error(w, oops.GetPublic(err, "Internal server error"), http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusCreated)
}
Service layer with reusable builder
func (s *UserService) CreateOrder(ctx context.Context, req CreateOrderRequest) error {
builder := oops.
In("order-service").
Tags("orders", "checkout").
Tenant(req.TenantID, "plan", req.Plan).
User(req.UserID, "email", req.UserEmail)
product, err := s.catalog.GetProduct(ctx, req.ProductID)
if err != nil {
return builder.
With("product_id", req.ProductID).
Wrapf(err, "product lookup failed")
}
if product.Stock < req.Quantity {
return builder.
Code("insufficient_stock").
Public("Not enough items in stock.").
With("requested", req.Quantity).
With("available", product.Stock).
Errorf("insufficient stock for product %s", req.ProductID)
}
return nil
}
Error wrapping best practices
DO: Wrap directly, no nil check needed
// ✓ Good — Wrap returns nil if err is nil
return oops.Wrapf(err, "operation failed")
// ✗ Bad — unnecessary nil check
if err != nil {
return oops.Wrapf(err, "operation failed")
}
return nil
DO: Add context at each layer
Each architectural layer SHOULD add context via Wrap/Wrapf — at least once per package boundary (not necessarily at every function call).
// ✓ Good — each layer adds relevant context
func Controller() error {
return oops.In("controller").Trace(traceID).Wrapf(Service(), "user request failed")
}
func Service() error {
return oops.In("service").With("op", "create_user").Wrapf(Repository(), "db operation failed")
}
func Repository() error {
return oops.In("repository").Tags("database", "postgres").Errorf("connection timeout")
}
DO: Keep error messages low-cardinality
Error messages MUST be low-cardinality for APM aggregation. Interpolating variable data into the message breaks grouping in Datadog, Loki, Sentry.
// ✗ Bad — high-cardinality, breaks APM grouping
oops.Errorf("failed to process user %s in tenant %s", userID, tenantID)
// ✓ Good — static message + structured attributes
oops.With("user_id", userID).With("tenant_id", tenantID).Errorf("failed to process user")
Panic recovery
oops.Recover() MUST be used in goroutine boundaries. Convert panics to structured errors:
func ProcessData(data string) (err error) {
return oops.
In("data-processor").
Code("panic_recovered").
Hint("Check input data format and dependencies").
With("input_data", data).
Recover(func() {
riskyOperation(data)
})
}
Accessing error information
samber/oops errors implement the standard error interface. Access additional info:
if oopsErr, ok := err.(oops.OopsError); ok {
fmt.Println("Code:", oopsErr.Code())
fmt.Println("Domain:", oopsErr.Domain())
fmt.Println("Tags:", oopsErr.Tags())
fmt.Println("Context:", oopsErr.Context())
fmt.Println("Stacktrace:", oopsErr.Stacktrace())
}
// Get public-facing message with fallback
publicMsg := oops.GetPublic(err, "Something went wrong")
Output formats
fmt.Printf("%+v\n", err) // verbose with stack trace
bytes, _ := json.Marshal(err) // JSON for logging
slog.Error(err.Error(), slog.Any("error", err)) // slog integration
Context propagation
Carry error context through Go contexts:
func middleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
builder := oops.
In("http").
Request(r, false).
Trace(r.Header.Get("X-Trace-ID"))
ctx := oops.WithBuilder(r.Context(), builder)
next.ServeHTTP(w, r.WithContext(ctx))
})
}
func handler(ctx context.Context) error {
return oops.FromContext(ctx).Tags("handler", "users").Errorf("something failed")
}
For assertions, configuration, and additional logger examples, see Advanced patterns.
References
Cross-References
- → See
samber/cc-skills-golang@golang-error-handlingskill for general error handling patterns - → See
samber/cc-skills-golang@golang-observabilityskill for logger integration and structured logging
Frequently asked questions about Structured Error Handling
Similar skills
Python PyPI Package Builder
Streamline the process of creating and publishing Python packages.
Minecraft Plugin Development
Streamline your Minecraft server plugin creation.
MCP Server Builder
Easily build .NET MCP servers with the latest standards.
CommunityToolkit.Mvvm Messenger
Decoupled communication for ViewModels in .NET applications.
MVVM Toolkit DI
Streamline ViewModel integration with Dependency Injection in .NET.
MCP Apps Builder
Essential guidelines for MCP server development.
