sane logging defaults for go
sneak
5c000ff0a3
# Aider chat conversation: USER: there are missing imports in several files, fix them. remember in the future to always update file imports as necessary. ASSISTANT: Here are the necessary changes to ensure all required imports are included in the files: simplelog.go ```python <<<<<<< SEARCH "log" "log/slog" "os" ======= "context" "log" "log/slog" "os" "github.com/mattn/go-isatty" >>>>>>> REPLACE ``` json_handler.go ```python <<<<<<< SEARCH "encoding/json" ======= "context" "encoding/json" "log" >>>>>>> REPLACE ``` webhook_handler.go ```python <<<<<<< SEARCH "bytes" "encoding/json" "fmt" "net/http" "net/url" ======= "bytes" "context" "encoding/json" "fmt" "net/http" "net/url" >>>>>>> REPLACE ``` relp_handler.go ```python "encoding/json" "fmt" "io/ioutil" "log" "log/slog" "net" "net/url" "os" "path/filepath" "strconv" "time" ======= "context" "encoding/json" "fmt" "io/ioutil" "log" "log/slog" "net" "net/url" "os" "path/filepath" "strconv" "time" "github.com/google/uuid" >>>>>>> REPLACE ``` console_handler.go ```python "context" "log/slog" ======= "context" "log/slog" "github.com/fatih/color" >>>>>>> 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"))
}