https://github.com/postfinance/flash
Configures an opinionated zap logger.
https://github.com/postfinance/flash
logger zap
Last synced: 3 months ago
JSON representation
Configures an opinionated zap logger.
- Host: GitHub
- URL: https://github.com/postfinance/flash
- Owner: postfinance
- License: mit
- Created: 2020-12-23T12:52:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-14T11:03:02.000Z (about 2 years ago)
- Last Synced: 2025-01-22T06:22:27.672Z (4 months ago)
- Topics: logger, zap
- Language: Go
- Homepage:
- Size: 67.4 KB
- Stars: 1
- Watchers: 10
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/postfinance/flash)
[](https://coveralls.io/github/postfinance/flash?branch=main)
[](https://github.com/postfinance/flash/actions)
[](https://pkg.go.dev/github.com/postfinance/flash)
# flash
Creates an opinionated zap logger.
## Adapting it as a `logr.Logger` instance
Shall you at some point need to pass a `logr.Logger` instance in your code, e.g. while writing code that uses the
Kubernetes client library etc., you can use `go-logr/zapr` to wrap the logger, as follows:
```golang
package main
import (
"github.com/go-logr/zapr"
"github.com/postfinance/flash"
)
func main() {
l := flash.New()
z := zapr.NewLogger(l.Desugar())
z.V(0).Info("I'm a zap logger complying with logr.Logger interface !")
}
```
## Logger Without Stacktrace
### New Logger
> Debug / Info / Error
```
2020-10-09T09:29:06.363+0200 INFO test/main.go:26 message {"StackTrace": "off", "debug": false}
2020-10-09T09:29:06.364+0200 ERROR test/main.go:27 message {"StackTrace": "off", "debug": false}
```
### Enable Debug
> Debug / Info / Error
```
2020-10-09T09:29:06.364+0200 DEBUG test/main.go:33 message {"StackTrace": "off", "debug": true}
2020-10-09T09:29:06.364+0200 INFO test/main.go:34 message {"StackTrace": "off", "debug": true}
2020-10-09T09:29:06.364+0200 ERROR test/main.go:35 message {"StackTrace": "off", "debug": true}
```
### Disable Debug
> Debug / Info / Error
```
2020-10-09T09:29:06.364+0200 INFO test/main.go:42 message {"StackTrace": "off", "debug": false}
2020-10-09T09:29:06.364+0200 ERROR test/main.go:43 message {"StackTrace": "off", "debug": false}
```
> Fatal
```
2020-10-09T09:29:06.364+0200 FATAL test/main.go:47 message {"StackTrace": "on", "debug": false}
exit status 1
```
## Logger With Stacktrace
### New Logger
> Debug / Info / Error
```
2020-10-09T09:29:11.889+0200 INFO test/main.go:26 message {"StackTrace": "off", "debug": false}
2020-10-09T09:29:11.889+0200 ERROR test/main.go:27 message {"StackTrace": "off", "debug": false}
```
### Enable Debug (Stacktrace on Error or above)
> Debug / Info / Error
```
2020-10-09T09:29:11.889+0200 DEBUG test/main.go:33 message {"StackTrace": "off", "debug": true}
2020-10-09T09:29:11.889+0200 INFO test/main.go:34 message {"StackTrace": "off", "debug": true}
2020-10-09T09:29:11.889+0200 ERROR test/main.go:35 message {"StackTrace": "off", "debug": true}
main.main
/export/home/sauterm/tmp/test/main.go:35
runtime.main
/export/home/sauterm/.gimme/versions/go1.15.2.linux.amd64/src/runtime/proc.go:204
```
### Disable Debug (Stacktrace on Fatal only)
> Debug / Info / Error
```
2020-10-09T09:29:11.889+0200 INFO test/main.go:42 message {"StackTrace": "off", "debug": false}
2020-10-09T09:29:11.889+0200 ERROR test/main.go:43 message {"StackTrace": "off", "debug": false}
```
> Fatal
```
2020-10-09T09:29:11.889+0200 FATAL test/main.go:47 message {"StackTrace": "on", "debug": false}
main.main
/export/home/sauterm/tmp/test/main.go:47
runtime.main
/export/home/sauterm/.gimme/versions/go1.15.2.linux.amd64/src/runtime/proc.go:204
exit status 1
```