README
¶
Golang graceful trace stack error packet
Golang tracks stack error package
Install
go get github.com/yezihack/e
Introduction
github.com/yezihack/e Project is a graceful way to track your stack information.
Easy to store in log, It also extends the 'error' package, custom 'code, msg' information.
Features
Trace stack error messages gracefully
- Based on
github.com/pkg/errorsPackage - Support 'code', 'msg' custom error code and error information
- Convenient storage of log 'JSON' files
- The stack information is displayed humanized
Documentation
https://godoc.org/github.com/yezihack/e
Simple use
package main
import (
"github.com/yezihack/e"
"log"
)
func foo() error {
return e.New("foo")
}
func main() {
err := foo()
if err != nil { // you need to determine whether it is a custom error, otherwise you cannot output stack information
if e.Assert(err) {
log.Println(e.Convert(err).ToStr()) // output string form
log.Println(e.Convert(err).ToArr()) // output array form
} else {
log.Println(err) // system error
}
}
}
Testing
go get github.com/smartystreets/goconvey
goconvey -port 8080
Example
- basic usage
- code usage
- compatible with error in old projects
- get extension error of extra
- used in gin)
- More waiting to be updated
Output general information and stack information (string or array)
package main
import (
"log"
"github.com/yezihack/e"
)
func foo(s string) error {
return e.New("foo," + s)
}
func main() {
// (1) general use
err := foo("stack error")
if err != nil {
log.Println(err)
}
// out:
// 2021/01/15 20:23:21 foo,stack error
// (2)output stack information by string
if e.Assert(err) { // you need to determine whether it is a custom error, otherwise you cannot output stack information.
log.Println(e.Convert(err).ToStr())
}
// out:
//2021/01/15 20:23:21 file:1.how.go, line:10, func:foo
//file:1.how.go, line:15, func:main
// (3) output stack information by array
if e.Assert(err) { // you need to determine whether it is a custom error, otherwise you cannot output stack information.
log.Println(e.Convert(err).ToArr())
}
// out
//2021/01/15 20:23:21 [file:1.how.go, line:10, func:foo file:1.how.go, line:15, func:main]
}
Error message with custom 'code'
package main
import (
"fmt"
"github.com/yezihack/e"
)
// if you use error with code
func fooCode() error {
return e.NewCode(400, "eoo error")
}
func main() {
err := fooCode()
if e.Assert(err) {
e1 := e.Convert(err)
fmt.Printf("code:%d, err:%s\n", e1.Code(), e1.Msg())
}
//out:
//code:400, err:eoo error
if e.Assert(err) {
e1 := e.Convert(err)
fmt.Printf("code:%d, err:%s\n", e1.Code(), e1.ToStr())
}
// out:
//code:400, err:file:2.code.go, line:11, func:fooCode
//file:2.code.go, line:15, func:main
}
Documentation
¶
Index ¶
- func As(err, target error) bool
- func Assert(e error) bool
- func ErrorCodeF(code int, format string, args ...interface{}) error
- func ErrorF(format string, args ...interface{}) error
- func Is(err, target error) bool
- func New(s string, extras ...error) error
- func NewCode(code int, s string, extras ...error) error
- func ToArr(err error) []string
- func ToStr(err error) string
- func UnWrap(err error) error
- func WithCodeMessage(code int, err error, msg string, extras ...error) error
- func WithCodeMessageF(code int, err error, format string, args ...interface{}) error
- func WithCodeStack(code int, err error, extras ...error) error
- func WithMessage(err error, msg string, extras ...error) error
- func WithMessageF(err error, format string, args ...interface{}) error
- func WithStack(err error, extras ...error) error
- type StackError
- func (c *StackError) Code() int
- func (c *StackError) Err() error
- func (c *StackError) Error() string
- func (c *StackError) Errs() []error
- func (c *StackError) ExistExtra() bool
- func (c *StackError) Msg() string
- func (c *StackError) ToArr() []string
- func (c *StackError) ToStr() string
- func (c *StackError) ToStrByExtra() string
- type StackSourceEntity
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithCodeMessage ¶
错误+信息+额外errs
func WithCodeMessageF ¶
错误+格式+信息
Types ¶
type StackError ¶
type StackError struct {
// contains filtered or unexported fields
}
错误自定义, 支持堆栈信息的错误结构体
type StackSourceEntity ¶
type StackSourceEntity struct {
File string `json:"file"` // 文件名称
LineCode string `json:"line"` // 行号
FuncName string `json:"func"` // 函数名称
}
定义输出的结构体
func MarshalStack ¶
func MarshalStack(err error) []*StackSourceEntity
MarshalStack implements pkg/errors stack trace marshaling.
Source Files
Click to show internal directories.
Click to hide internal directories.