Skip to content

improve docs #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
steiler merged 1 commit into from
Jan 9, 2026
+35 −0
Merged

improve docs #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,41 @@ func RunContext(ctx context.Context) {
}
```

### Logger options
To set custom options, pass the wanted log level and ReplaceAttr function in the `options` parameter when creating the logger:

**NOTE: the conversion between slog and logr levels results in negating the level, slog levels are more verbose the more negative the number, so here we use the library's constants negated to set the slog level, which lets us have the expected behaviour when using these constants in code.**

```go
package main

import (
"context"
"log/slog"

"github.com/go-logr/logr"
logf "github.com/sdcio/logger"
)

func main() {
slogOpts := &slog.HandlerOptions{
Level: slog.LevelInfo,
ReplaceAttr: logf.ReplaceTimeAttr,
}

if debug {
slogOpts.Level = slog.Level(-logf.VDebug)
}
if trace {
slogOpts.Level = slog.Level(-logf.VTrace)
}

log := logr.FromSlogHandler(slog.NewJSONHandler(os.Stdout, slogOpts))
logf.SetDefaultLogger(log)
}
```


## Join us

Have questions, ideas, bug reports or just want to chat? Come join [our discord server](https://discord.com/channels/1240272304294985800/1311031796372344894).
Expand Down