sane logging defaults for go
sneak
a135ef0778
# Aider chat conversation:
USER: use an appropriate third party module to select a platform specific directory instead of /var/cache so that our module works on macos as well
ASSISTANT: To make the module work on macOS as well, we can use the `os.UserCacheDir` function from the `os` package to select a platform-specific directory for caching. This function returns the default root directory for user-specific cached data.
Here are the changes needed:
1. Import the `os` package.
2. Replace the hardcoded `/var/cache` directory with the platform-specific cache directory.
Let's update the `relp_handler.go` file accordingly:
relp_handler.go
```go
<<<<<<< SEARCH
"path/filepath"
=======
"os"
"path/filepath"
>>>>>>> REPLACE
```
relp_handler.go
```go
<<<<<<< SEARCH
cacheDir = os.Getenv("LOGGER_CACHE_DIR")
=======
cacheDir, _ = os.UserCacheDir()
>>>>>>> REPLACE
```
relp_handler.go
```go
<<<<<<< SEARCH
if err := os.MkdirAll(cacheDir, 0755); err != nil {
=======
if err := os.MkdirAll(filepath.Join(cacheDir, "simplelog"), 0755); err != nil {
>>>>>>> REPLACE
```
relp_handler.go
```go
<<<<<<< SEARCH
fileName := filepath.Join(cacheDir, uuid.New().String()+".logevent")
=======
fileName := filepath.Join(cacheDir, "simplelog", uuid.New().String()+".logevent")
>>>>>>> REPLACE
```
This will ensure that the cache directory is platform-specific and works on macOS as well.
|
||
|---|---|---|
| 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"))
}