Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/golang-cz/devslog
devslog - Go slog.Handler for development
https://github.com/golang-cz/devslog
Last synced: about 2 months ago
JSON representation
devslog - Go slog.Handler for development
- Host: GitHub
- URL: https://github.com/golang-cz/devslog
- Owner: golang-cz
- License: mit
- Created: 2023-08-01T12:37:12.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-10T12:14:16.000Z (9 months ago)
- Last Synced: 2024-04-14T01:00:29.350Z (9 months ago)
- Language: Go
- Homepage:
- Size: 69.3 KB
- Stars: 79
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-slog - devslog
README
# 🧻 devslog - Go [slog.Handler](https://pkg.go.dev/log/slog#Handler) for development
[](https://github.com/golang-cz/devslog/blob/master/LICENSE)
[](https://goreportcard.com/report/github.com/golang-cz/devslog)
[](https://pkg.go.dev/github.com/golang-cz/devslog)
`devslog` is a zero dependency structured logging handler for Go's [`log/slog`](https://pkg.go.dev/log/slog) package with pretty and colorful output for developers.
### Devslog output
#### Compared to
`TextHandler`
`JSONHandler`
## Install
```
go get github.com/golang-cz/devslog@latest
```
## Examples
### Logger without options
```go
logger := slog.New(devslog.NewHandler(os.Stdout, nil))
// optional: set global logger
slog.SetDefault(logger)
```
### Logger with custom options
```go
// new logger with options
opts := &devslog.Options{
MaxSlicePrintSize: 4,
SortKeys: true,
TimeFormat: "[04:05]",
NewLineAfterLog: true,
DebugColor: devslog.Magenta,
StringerFormatter: true,
}
logger := slog.New(devslog.NewHandler(os.Stdout, opts))
// optional: set global logger
slog.SetDefault(logger)
```
### Logger with default slog options
Handler accepts default [slog.HandlerOptions](https://pkg.go.dev/golang.org/x/exp/slog#HandlerOptions)
```go
// slog.HandlerOptions
slogOpts := &slog.HandlerOptions{
AddSource: true,
Level: slog.LevelDebug,
}
// new logger with options
opts := &devslog.Options{
HandlerOptions: slogOpts,
MaxSlicePrintSize: 4,
SortKeys: true,
NewLineAfterLog: true,
StringerFormatter: true,
}
logger := slog.New(devslog.NewHandler(os.Stdout, opts))
// optional: set global logger
slog.SetDefault(logger)
```
### Example usage
```go
slogOpts := &slog.HandlerOptions{
AddSource: true,
Level: slog.LevelDebug,
}
var logger *slog.Logger
if production {
logger = slog.New(slog.NewJSONHandler(os.Stdout, slogOpts))
} else {
opts := &devslog.Options{
HandlerOptions: slogOpts,
MaxSlicePrintSize: 10,
SortKeys: true,
NewLineAfterLog: true,
StringerFormatter: true,
}
logger = slog.New(devslog.NewHandler(os.Stdout, opts))
}
// optional: set global logger
slog.SetDefault(logger)
```
## Options
| Parameter | Description | Default | Value |
| ------------------ | -------------------------------------------------------------- | -------------- | -------------------- |
| MaxSlicePrintSize | Specifies the maximum number of elements to print for a slice. | 50 | uint |
| SortKeys | Determines if attributes should be sorted by keys. | false | bool |
| TimeFormat | Time format for timestamp. | "[15:04:05]" | string |
| NewLineAfterLog | Add blank line after each log | false | bool |
| StringIndentation | Indent \n in strings | false | bool |
| DebugColor | Color for Debug level | devslog.Blue | devslog.Color (uint) |
| InfoColor | Color for Info level | devslog.Green | devslog.Color (uint) |
| WarnColor | Color for Warn level | devslog.Yellow | devslog.Color (uint) |
| ErrorColor | Color for Error level | devslog.Red | devslog.Color (uint) |
| MaxErrorStackTrace | Max stack trace frames for errors | 0 | uint |
| StringerFormatter | Use Stringer interface for formatting | false | bool |
| NoColor | Disable coloring | false | bool |