sane logging defaults for go
sneak
4892ce2f86
# Aider chat conversation:
USER: the error messages are insufficiently descriptive. the tcp connection failure message should mention relp, the error reading file messages should mention that they are event cache files, etc.
ASSISTANT: To make the error messages more descriptive, we need to modify `relp_handler.go`:
1. Update the error message in `Startup()` to mention RELP.
2. Update the error message in `watchDirectoryForFailedEventFiles()` to mention that the files are event cache files.
Here are the *SEARCH/REPLACE* blocks:
relp_handler.go
```go
<<<<<<< SEARCH
if err != nil {
if relpDebug {
log.Printf("Failed to establish TCP connection: %v", err)
}
return fmt.Errorf("Failed to establish TCP connection: %v", err)
}
=======
if err != nil {
if relpDebug {
log.Printf("Failed to establish TCP connection to RELP server: %v", err)
}
return fmt.Errorf("Failed to establish TCP connection to RELP server: %v", err)
}
>>>>>>> REPLACE
```
relp_handler.go
```go
<<<<<<< SEARCH
log.Printf("Error reading file %s: %v", file.Name(), err)
=======
log.Printf("Error reading event cache file %s: %v", file.Name(), err)
>>>>>>> REPLACE
```
|
||
|---|---|---|
| tools | ||
| .gitignore | ||
| console_handler.go | ||
| custom_logger.go | ||
| event.go | ||
| go.mod | ||
| go.sum | ||
| handler.go | ||
| json_handler.go | ||
| Makefile | ||
| README.md | ||
| relp_handler.go | ||
| simplelog_test.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"))
}