mirror of
https://github.com/gomods/athens
synced 2026-02-03 14:20:31 +00:00
23 lines
1.6 KiB
Go
23 lines
1.6 KiB
Go
// Package errors provides a central interface to handling
|
|
// all errors in the Athens domain. It closely follows Upspin's error
|
|
// handling with a few differences that reflect the system design
|
|
// of the Athen's architecture. If you're unfamiliar with Upspin's error
|
|
// handling, we recommend that you read this article first before
|
|
// coming back here https://commandcenter.blogspot.com/2017/12/error-handling-in-upspin.html.
|
|
// Athen's errors are central around dealing with modules. So every error
|
|
// will most likely carry a Module and a Version inside of them. Furthermore,
|
|
// because Athens is designed to run on multiple clouds, we have to design
|
|
// our errors and our logger to be friendly with each other. Therefore,
|
|
// the logger's SystemError method, although it accepts any type of error,
|
|
// it knows how to deal with errors constructed from this package in a debuggable way.
|
|
// To construct an Athens error, call the errors.E function. The E function takes
|
|
// an Op and a variadic of any, but the values of the Error struct are what you can
|
|
// pass to it. Values such as the error Kind, Module, Version, Error Message,
|
|
// and Seveirty (seriousness of an error) are all optional. The only truly required value is
|
|
// the errors.Op so you can construct a traceable stack that leads to where
|
|
// the error happened. However, adding more information can help catch an issue
|
|
// quicker and would help Cloud Log Monitoring services be more efficient to maintainers
|
|
// as you can run queries on Athens Errors such as "Give me all errors of KindUnexpected"
|
|
// or "Give me all errors where caused by a particular Module"
|
|
package errors
|