jvoegele
Errata - Structured error handling for Elixir
Announcing Errata, an Elixir library for consistent and structured error handling.
Errata is an Elixir library that promotes a consistent and structured approach to error handling.
Errata provides support for defining custom structured error types, which can either be returned as error values or raised as exceptions.
Errata errors are named, structured types that represent error conditions in an application or library. Being named types means that errors have a unique and meaningful name within a particular context. Being structured types means that errors have a well-defined, consistent structure identifying the nature of the error, and can also have arbitrary contextual information attached to them for logging or debugging purposes.
Most Liked Responses
jvoegele
Errata 0.9.0 is out, and it’s a sizable release — some new conveniences, sharper defaults, and a thorough documentation overhaul.
New functions
-
Errata.create/2— create an error of any type while still capturing the call-site environment, without having torequireeach error module. Since you alreadyrequire Erratato use the guards, you can justaliasyour error modules and write:require Errata alias MyApp.Orders.OrderNotFound Errata.create(OrderNotFound, reason: :not_found, context: %{order_id: id}) -
Errata.to_map/1— convert any Errata error to a plain, JSON-encodable map without needing to know its specific module. Handy at a system boundary (e.g. a Phoenix fallback controller) that handles many error types uniformly. -
Errata.display_message/1— the bare, human-readable message intended for end users, as distinct fromException.message/1, which combines the message and:reasonfor logs and raised-exception output.
Sharper defaults
- Creating an error with an unrecognized or misspelled key (say,
reasn:instead ofreason:) now raises anArgumentErrorinstead of silently dropping it.
This is the one breaking change in 0.9.0 — see Upgrading below.
Fixes
- Serialized errors are cleaner: JSON output no longer leaks the
Elixir.prefix on module names, andenv.file_lineno longer has a stray trailing colon.
Docs & tooling
- The guide has been reorganized around a single running example (an
Ordersbounded context), with clearer guidance on choosing between domain, infrastructure, and general errors, and on when to use a distinct error type vs. a:reason. - There’s now a CI pipeline that runs the test suite across Elixir 1.15–1.18 and OTP 25–27, plus formatting, Credo, Dialyzer, and docs checks.
Upgrading
Bump your dependency to:
{:errata, "~> 0.9.0"}
The only breaking change is the stricter param validation. If you were (perhaps unknowingly) relying on extra keys being ignored, you’ll now get a clear ArgumentError — in practice this usually just surfaces a typo.
Thanks to everyone who’s given Errata a try and shared feedback; it’s genuinely shaped this release. More is always welcome.
jvoegele
Quick update for anyone following along: Errata has reached 1.0.0 — its first stable, production-ready release, with the public API now covered by Semantic Versioning. ![]()
Since this thread it has grown a fair bit: error wrapping/chaining (a :cause field), context enrichment as errors propagate, declared-and-validated :reasons, error reporting via structured logging and telemetry, and HTTP-status mapping by error kind — alongside a thorough documentation pass.
I’ve written up the full 1.0.0 picture, with examples, in a dedicated thread:
Thanks to everyone who’s tried Errata and shared feedback — it genuinely shaped the road to 1.0.
jvoegele
Hi @nathanl,
The create/1 macro uses Process.info(self(), :current_stacktrace) to fill in the stacktrace. I’m not sure about the efficiency of this function, but I would venture to say that if you are using create/1 for creating Errata errors in your codebase then it would probably not be on the critical path and would not affect overall system performance to any appreciable degree.
Popular in Announcing
Other popular topics
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #javascript
- #podcasts
- #code-sync
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #advent-of-code
- #elixirconf-us
- #distillery
- #processes
- #forms
- #api
- #metaprogramming
- #security
- #performance








