sane logging defaults for go
sneak
500b4b0a96
# Aider chat conversation:
USER: the console logger should show the filename and line number of the log item. type slog.Record has no field or method Source.
ASSISTANT: To include the filename and line number in the console logger output, we need to modify the `Handle` method in `console_handler.go`. Since `slog.Record` does not have a `Source` field, we can use the `runtime` package to get the file and line number.
Here are the *SEARCH/REPLACE* blocks:
console_handler.go
```go
<<<<<<< SEARCH
"time"
=======
"runtime"
"time"
>>>>>>> REPLACE
```
console_handler.go
```go
<<<<<<< SEARCH
// Extract the source file and line number
source := record.Source
fmt.Println(colorFunc("%s [%s] %s:%d: %s", timestamp, record.Level, source.File, source.Line, record.Message))
=======
// Get the caller information
_, file, line, ok := runtime.Caller(5)
if !ok {
file = "???"
line = 0
}
fmt.Println(colorFunc("%s [%s] %s:%d: %s", timestamp, record.Level, file, line, record.Message))
>>>>>>> REPLACE
```
|
||
|---|---|---|
| tools | ||
| .gitignore | ||
| console_handler.go | ||
| event.go | ||
| go.mod | ||
| go.sum | ||
| handler.go | ||
| json_handler.go | ||
| Makefile | ||
| README.md | ||
| relp_handler.go | ||
| simplelog_test.go | ||
| simplelog.go | ||
| TODO | ||
| webhook_handler.go | ||
simplelog
simplelog is an opinionated logging package designed to facilitate easy and structured logging in Go applications with an absolute minimum of boilerplate.
The idea is that you can add a single import line which replaces the
stdlib log/slog default handler, and solve the 90% case for logging.
Features
- if output is a tty, outputs pretty color logs
- if output is not a tty, outputs json
- supports delivering logs via tcp RELP (e.g. to remote rsyslog using imrelp)
- supports delivering each log message via a webhook
Installation
To use simplelog, first ensure your project is set up with Go modules:
go mod init your_project_name
Then, add SimpleLog to your project:
go get git.eeqj.de/sneak/go-simplelog
Usage
Below is an example of how to use SimpleLog in a Go application. This example is provided in the form of a main.go file, which demonstrates logging at various levels using structured logging syntax.
package main
import (
"log/slog"
_ "git.eeqj.de/sneak/go-simplelog"
)
func main() {
// log structured data with slog as usual:
slog.Info("User login attempt", slog.String("user", "JohnDoe"), slog.Int("attempt", 3))
slog.Warn("Configuration mismatch", slog.String("expected", "config.json"), slog.String("found", "config.dev.json"))
slog.Error("Failed to save data", slog.String("reason", "permission denied"))
}