sane logging defaults for go
Go to file
Jeffrey Paul 00b2bfeeb8 aider: Fixed undefined variables and types, updated handlers to use `slog.Handler` interface, and defined missing `event` variables.
# Aider chat conversation:

USER: ../console_handler.go:15:77: undefined: slog.Field
../console_handler.go:16:51: undefined: event
../json_handler.go:14:33: undefined: slog
../json_handler.go:15:30: undefined: event
../relp_handler.go:117:33: undefined: slog
../relp_handler.go:119:15: undefined: event
../simplelog.go:20:77: undefined: slog.Field

ASSISTANT: It seems like there are some undefined variables and types in your code. Let's fix them.

In `console_handler.go`, `slog.Field` and `event` are undefined. We need to replace `slog.Field` with `simplelog.Field` and define `event`.

In `json_handler.go`, `slog` and `event` are undefined. We need to replace `slog` with `simplelog` and define `event`.

In `relp_handler.go`, `slog` and `event` are undefined. We need to replace `slog` with `simplelog` and define `event`.

In `simplelog.go`, `slog.Field` is undefined. We need to replace `slog.Field` with `simplelog.Field`.

Here are the *SEARCH/REPLACE* blocks:

console_handler.go
```go
<<<<<<< SEARCH
func (c *ConsoleHandler) Log(level slog.Level, message string
^C KeyboardInterrupt

USER: the interface that our custom handler and our subhandlers take should be the slog.Handler interface from the go standard library log/slog package.

ASSISTANT: I see, you want to use the `slog.Handler` interface from the `log/slog` package.

Let's modify the `handler.go` file to import `log/slog` and use `slog.Handler` instead of `Handler`.

handler.go
```go
<<<<<<< SEARCH
package simplelog

// Handler defines the interface for different log outputs.
type Handler interface {
	Log(event Event) error
}
=======
package simplelog

import "log/slog"

// Handler defines the interface for different log outputs.
type Handler interface {
	slog.Handler
}
>>>>>>> REPLACE
```

Now, we need to update the `Log` method in all the handlers to match the `slog.Handler` interface.

console_handler.go
```go
<<<<<<< SEARCH
func (c *ConsoleHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	color.New(color.FgBlue).PrintfFunc()("%s: %s\n", event.Level, event.Message)
	return nil
}
=======
func (c *ConsoleHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	color.New(color.FgBlue).PrintfFunc()("%s: %s\n", level, message)
	return nil
}
>>>>>>> REPLACE
```

json_handler.go
```go
<<<<<<< SEARCH
func (j *JSONHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	jsonData, _ := json.Marshal(event)
	log.Println(string(jsonData))
	return nil
}
=======
func (j *JSONHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	event := simplelog.NewEvent(level.String(), message, data)
	jsonData, _ := json.Marshal(event)
	log.Println(string(jsonData))
	return nil
}
>>>>>>> REPLACE
```

relp_handler.go
```go
<<<<<<< SEARCH
func (r *RELPHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	select {
	case r.ch <- event:
		return nil // Successfully sent event to channel
	default:
		return fmt.Errorf("failed to log event: channel is full")
	}
}
=======
func (r *RELPHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	event := simplelog.NewEvent(level.String(), message, data)
	select {
	case r.ch <- event:
		return nil // Successfully sent event to channel
	default:
		return fmt.Errorf("failed to log event: channel is full")
	}
}
>>>>>>> REPLACE
```

webhook_handler.go
```go
<<<<<<< SEARCH
func (w *WebhookHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	jsonData, err := json.Marshal(event)
	if err != nil {
		return fmt.Errorf("error marshaling event: %v", err)
	}
	response, err := http.Post(w.webhookURL, "application/json", bytes.NewBuffer(jsonData))
	if err != nil {
		return err
	}
	defer response.Body.Close()
	return nil
}
=======
func (w *WebhookHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	event := simplelog.NewEvent(level.String(), message, data)
	jsonData, err := json.Marshal(event)
	if err != nil {
		return fmt.Errorf("error marshaling event: %v", err)
	}
	response, err := http.Post(w.webhookURL, "application/json", bytes.NewBuffer(jsonData))
	if err != nil {
		return err
	}
	defer response.Body.Close()
	return nil
}
>>>>>>> REPLACE
```

simplelog.go
```go
<<<<<<< SEARCH
type CustomHandler struct {
	handlers []slog.Handler
}

func (cl *CustomHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	for _, handler := range cl.handlers {
		if err := handler.Log(level, message, data...); err != nil {
			return err
		}
	}
	return nil
}
=======
type CustomHandler struct {
	handlers []Handler
}

func (cl *CustomHandler) Log(level slog.Level, message string, data ...slog.Field) error {
	for _, handler := range cl.handlers {
		if err := handler.Log(level, message, data...); err != nil {
			return err
		}
	}
	return nil
}
>>>>>>> REPLACE
```

Please let me know if you need further changes.
2024-05-14 04:52:13 -07:00
tools aider is not great 2024-05-14 04:50:42 -07:00
.gitignore add .gitignore 2024-05-13 21:43:54 -07:00
Makefile initial 2024-05-13 21:43:47 -07:00
README.md initial 2024-05-13 21:43:47 -07:00
TODO initial 2024-05-13 21:43:47 -07:00
console_handler.go aider: Fixed undefined variables and types, updated handlers to use `slog.Handler` interface, and defined missing `event` variables. 2024-05-14 04:52:13 -07:00
event.go initial 2024-05-13 21:43:47 -07:00
go.mod initial 2024-05-13 21:43:47 -07:00
go.sum initial 2024-05-13 21:43:47 -07:00
handler.go aider: Fixed undefined variables and types, updated handlers to use `slog.Handler` interface, and defined missing `event` variables. 2024-05-14 04:52:13 -07:00
json_handler.go aider: Fixed undefined variables and types, updated handlers to use `slog.Handler` interface, and defined missing `event` variables. 2024-05-14 04:52:13 -07:00
relp_handler.go aider: Fixed undefined variables and types, updated handlers to use `slog.Handler` interface, and defined missing `event` variables. 2024-05-14 04:52:13 -07:00
simplelog.go aider: Fixed undefined variables and types, updated handlers to use `slog.Handler` interface, and defined missing `event` variables. 2024-05-14 04:52:13 -07:00
simplelog_test.go initial 2024-05-13 21:43:47 -07:00
webhook_handler.go aider: Fixed undefined variables and types, updated handlers to use `slog.Handler` interface, and defined missing `event` variables. 2024-05-14 04:52:13 -07:00

README.md

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"))
}