Documentation
¶
Overview ¶
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"
Index ¶
- Constants
- func AsErr(err error, target any) bool
- func E(op Op, args ...any) error
- func Expect(err error, kinds ...int) logrus.Level
- func Is(err error, kind int) bool
- func IsErr(err, target error) bool
- func IsNotFoundErr(err error) bool
- func IsRepoNotFoundErr(err error) bool
- func Kind(err error) int
- func KindText(err error) string
- func Severity(err error) logrus.Level
- type Error
- type M
- type Op
- type V
Constants ¶
const ( KindNotFound = http.StatusNotFound KindBadRequest = http.StatusBadRequest KindUnexpected = http.StatusInternalServerError KindAlreadyExists = http.StatusConflict KindRateLimit = http.StatusTooManyRequests KindNotImplemented = http.StatusNotImplemented KindRedirect = http.StatusMovedPermanently )
Kind enums.
Variables ¶
This section is empty.
Functions ¶
func E ¶
E is a helper function to construct an Error type Operation always comes first, module path and version come second, they are optional. Args must have at least an error or a string to describe what exactly went wrong. You can optionally pass a Logrus severity to indicate the log level of an error based on the context it was constructed in.
func Expect ¶ added in v0.6.0
Expect is a helper that returns an Info level if the error has the expected kind, otherwise it returns an Error level.
func IsNotFoundErr ¶ added in v0.1.0
IsNotFoundErr helper function for KindNotFound.
func IsRepoNotFoundErr ¶ added in v0.2.0
IsRepoNotFoundErr returns true if the Go command line hints at a repository not found.
Types ¶
type Error ¶
type Error struct {
// Kind categories Athens errors into a smaller
// subset of errors. This way we can generalize
// what an error really is: such as "not found",
// "bad request", etc. The official categories
// are HTTP status code but the ones we use are
// imported into this package.
Kind int
Op Op
Module M
Version V
Err error
Severity logrus.Level
}
Error is an Athens system error. It carries information and behavior as to what caused this error so that callers can implement logic around it.
type M ¶
type M string
M represents a module in an error this is so that we can distinguish a module from a regular error string or version.
Source Files