Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snwfdhmp/errlog
Reduce debugging time. Use static & stack-trace analysis to identify the error immediately.
https://github.com/snwfdhmp/errlog
debugging-tool error-log golang
Last synced: 14 days ago
JSON representation
Reduce debugging time. Use static & stack-trace analysis to identify the error immediately.
- Host: GitHub
- URL: https://github.com/snwfdhmp/errlog
- Owner: snwfdhmp
- License: mit
- Created: 2019-02-16T23:19:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T14:59:05.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:51:23.454Z (3 months ago)
- Topics: debugging-tool, error-log, golang
- Language: Go
- Homepage:
- Size: 86.9 KB
- Stars: 458
- Watchers: 6
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - errlog - Hackable package that determines responsible source code for an error (and some other fast-debugging features). Pluggable to any logger in-place. (Error Handling / Search and Analytic Databases)
- go-awesome - errlog - Use static and stack trace analysis to quickly determine which function call caused the error (Open source library / Error Handling)
- awesome-go-extra - errlog - trace analysis to determine which func call causes the error.|407|17|0|2019-02-16T23:19:05Z|2020-11-30T18:28:01Z| (Error Handling / Advanced Console UIs)
README
# Errlog: reduce debugging time while programming [](https://goreportcard.com/report/github.com/snwfdhmp/errlog) [](https://github.com/sindresorhus/awesome) [](http://godoc.org/github.com/snwfdhmp/errlog) [](https://github.com/snwfdhmp/errlog/issues) [](https://github.com/snwfdhmp/errlog/LICENSE)
## Introduction
Use errlog to improve error logging and **speed up debugging while you create amazing code** :
- Highlight source code
- **Detect and point out** which func call is causing the fail
- Pretty stack trace
- **No-op mode** for production
- Easy implementation, adaptable logger
- Plug to any current project without changing you or your teammates habits
- Plug to **your current logging system**
|Go to|
|---|
|[Get started](#get-started)|
|[Documentation](#documentation)|
|[Examples](#example)|
|[Tweaking](#tweak-as-you-need)|
|[Feedbacks](#feedbacks)|
|[Contributions](#contributions)|
|[License](#license-information)|
|[Contributors](#contributors)|
## Get started
### Install
```shell
go get github.com/snwfdhmp/errlog
```
### Usage
Replace your `if err != nil` with `if errlog.Debug(err)` to add debugging informations.
```golang
func someFunc() {
//...
if errlog.Debug(err) { // will debug & pass if err != nil, will ignore if err == nil
return
}
}
```
In production, call `errlog.DefaultLogger.Disable(true)` to enable no-op (equivalent to `if err != nil`)
## Tweak as you need
You can configure your own logger with the following options :
```golang
type Config struct {
PrintFunc func(format string, data ...interface{}) //Printer func (eg: fmt.Printf)
LinesBefore int //How many lines to print *before* the error line when printing source code
LinesAfter int //How many lines to print *after* the error line when printing source code
PrintStack bool //Shall we print stack trace ? yes/no
PrintSource bool //Shall we print source code along ? yes/no
PrintError bool //Shall we print the error of Debug(err) ? yes/no
ExitOnDebugSuccess bool //Shall we os.Exit(1) after Debug has finished logging everything ? (doesn't happen when err is nil). Will soon be replaced by ExitFunc to enable panic-ing the current goroutine. (if you need this quick, please open an issue)
}
```
> As we don't yet update automatically this README immediately when we add new features, this definition may be outdated. (Last update: 2019/08/07)
> [See the struct definition in godoc.org](https://godoc.org/github.com/snwfdhmp/errlog#Config) for the up to date definition
## Example
### Try yourself
| Name and link | Description |
| --- | --- |
| [Basic](examples/basic/basic.go) | standard usage, quick setup
| [Custom](examples/custom/custom.go) | guided configuration for fulfilling your needs |
| [Disabled](examples/disabled/disabled.go) | how to disable the logging & debugging (eg: for production use) |
| [Failing line far away](examples/failingLineFar/failingLineFar.go) | example of finding the func call that caused the error while it is lines away from the errlog.Debug call |
| [Pretty stack trace](examples/stackTrace/stackTrace.go) | pretty stack trace printing instead of debugging. |
### Just read
#### Basic example
> Note that in the example, you will see some unuseful func. Those are made to generate additional stack trace levels for the sake of example
We're going to use this sample program :
```golang
func main() {
fmt.Println("Program start")
wrapingFunc() //call to our important function
fmt.Println("Program end")
}
func wrapingFunc() {
someBigFunction() // call some func
}
func someBigFunction() {
someDumbFunction() // just random calls
someSmallFunction() // just random calls
someDumbFunction() // just random calls
// Here it can fail, so instead of `if err != nil` we use `errlog.Debug(err)`
if err := someNastyFunction(); errlog.Debug(err) {
return
}
someSmallFunction() // just random calls
someDumbFunction() // just random calls
}
func someSmallFunction() {
_ = fmt.Sprintf("I do things !")
}
func someNastyFunction() error {
return errors.New("I'm failing for some reason") // simulate an error
}
func someDumbFunction() bool {
return false // just random things
}
```
#### Output
We are able to **detect and point out which line is causing the error**.
### Custom Configuration Example
Let's see what we can do with a **custom configuration.**
```golang
debug := errlog.NewLogger(&errlog.Config{
// PrintFunc is of type `func (format string, data ...interface{})`
// so you can easily implement your own logger func.
// In this example, logrus is used, but any other logger can be used.
// Beware that you should add '\n' at the end of format string when printing.
PrintFunc: logrus.Printf,
PrintSource: true, //Print the failing source code
LinesBefore: 2, //Print 2 lines before failing line
LinesAfter: 1, //Print 1 line after failing line
PrintError: true, //Print the error
PrintStack: false, //Don't print the stack trace
ExitOnDebugSuccess: true, //Exit if err
})
```
> Please note: This definition may be outdated. (Last update: 2019/08/07)
> [See the struct definition in godoc.org](https://godoc.org/github.com/snwfdhmp/errlog#Config) for the up to date definition
#### Output
### When the failing func call is a few lines away
Even when the func call is a few lines away, there is no problem for finding it.
#### Output
## Documentation
Documentation can be found here : [](http://godoc.org/github.com/snwfdhmp/errlog)
## Feedbacks
Feel free to open an issue for any feedback or suggestion.
I fix process issues quickly.
## Contributions
We are happy to collaborate with you :
- Ask for a new feature: [Open an issue](https://github.com/snwfdhmp/errlog/issues/new)
- Add your feature: [Open a PR](https://github.com/snwfdhmp/errlog/compare)
When submitting a PR, please apply Effective Go best practices. For more information: https://golang.org/doc/effective_go.html
## License information
Click the following badge to open LICENSE information.
[](https://github.com/snwfdhmp/errlog/LICENSE)
## Contributors
### Major
- [snwfdhmp](https://github.com/snwfdhmp): Author and maintainer
- [chemidy](https://github.com/chemidy): Added important badges
### Minor fixes
- [orisano](https://github.com/orisano)
- [programmingman](https://github.com/programmingman)