Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikoksr/simplog
A simple and opinionated library that lets you set up and use zap quickly.
https://github.com/nikoksr/simplog
go golang logger logging simple uber-zap zap
Last synced: 4 months ago
JSON representation
A simple and opinionated library that lets you set up and use zap quickly.
- Host: GitHub
- URL: https://github.com/nikoksr/simplog
- Owner: nikoksr
- License: mit
- Created: 2020-03-17T22:31:00.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-10-29T10:52:18.000Z (about 2 years ago)
- Last Synced: 2024-06-19T18:11:34.303Z (7 months ago)
- Topics: go, golang, logger, logging, simple, uber-zap, zap
- Language: Go
- Homepage:
- Size: 114 KB
- Stars: 20
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/nikoksr/simplog)
[](https://goreportcard.com/report/github.com/nikoksr/simplog)
[](https://www.codacy.com/gh/nikoksr/simplog/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nikoksr/simplog&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/nikoksr/simplog/maintainability)
[](https://pkg.go.dev/github.com/nikoksr/simplog)
A simple and opinionated library that lets you set up and use zap quickly.
#### About
Simplog is a small library that sets [zap](https://github.com/uber-go/zap) up in a way that is easy to use and provides
some additional features. Simplog is opinionated and tries to provide a good default configuration for most use cases.
If you need more features, you may use the resulting zap logger directly.
#### Features
- Client and server modes
- Visualized log levels
- Optional context-binding support
- Easy to use
```bash
go get -u github.com/nikoksr/simplog
```
#### Example Code
> For more examples, see the [examples](examples) directory.
```go
package main
import "github.com/nikoksr/simplog"
func main() {
// Using the manual configuration; alternatively you can use NewClientLogger() or NewServerLogger().
logger := simplog.NewWithOptions(&simplog.Options{
Debug: false,
IsServer: true,
})
// At this point, you're using a zap.SugaredLogger and can use it as you would normally do.
logger.Info("You're awesome!")
logger.Warn("Coffee is almost empty!")
logger.Error("Unable to operate, caffein levels too low.")
}
```
#### Example Outputs
##### Client & server mode in debug
> In debug mode, independent of the mode, the logger will print all messages greater-equal than the debug-level in a human readable format.
```bash
2022-10-23T14:25:15.537+0200 INFO simplog test-simplog/main.go:12 You're awesome!
2022-10-23T14:25:15.537+0200 WARN simplog test-simplog/main.go:13 Coffee is almost empty!
2022-10-23T14:25:15.537+0200 ERROR simplog test-simplog/main.go:14 Unable to operate, caffein levels too low.
```
##### Client mode in production
> In production mode, the client logger will print all messages greater-equal than the info-level in a human readable format and replace the log level with a colored emoji.
>
> The symbols are configurable and can be set to any string.
```bash
💡 You're awesome!
⚠️ Coffee is almost empty!
🔥 Unable to operate, caffein levels too low.
```
##### Server mode in production
> In production mode, the server logger will print all messages greater-equal than the info-level in a structured format.
```bash
{"level":"info","ts":1666528089.4873903,"logger":"simplog","caller":"test-simplog/main.go:12","msg":"You're awesome!"}
{"level":"warn","ts":1666528089.4874253,"logger":"simplog","caller":"test-simplog/main.go:13","msg":"Coffee is almost empty!"}
{"level":"error","ts":1666528089.487434,"logger":"simplog","caller":"test-simplog/main.go:14","msg":"Unable to operate, caffein levels too low."}
```
#### Credits
- Logo by the amazing [MariaLetta/free-gophers-pack](https://github.com/MariaLetta/free-gophers-pack)