sane logging defaults for go
Go to file
sneak 8b30a2f205 aider: Fix undefined slog.Field error in console_handler.go by implementing the slog.Handler interface correctly.
# Aider chat conversation:

USER: ../console_handler.go:15:77: undefined: slog.Field

ASSISTANT: To fix the undefined `slog.Field` error in `console_handler.go`, we need to ensure that the `ConsoleHandler` implements the `slog.Handler` interface correctly. The `Log` method should be replaced with the `Handle` method, which takes a `slog.Record` as an argument.

Here is the necessary change:

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", level, message)
	return nil
}
=======
func (c *ConsoleHandler) Handle(ctx context.Context, record slog.Record) error {
	color.New(color.FgBlue).PrintfFunc()("%s: %s\n", record.Level, record.Message)
	return nil
}

func (c *ConsoleHandler) Enabled(ctx context.Context, level slog.Level) bool {
	return true
}

func (c *ConsoleHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
	return c
}

func (c *ConsoleHandler) WithGroup(name string) slog.Handler {
	return c
}
>>>>>>> REPLACE
```

This change ensures that the `ConsoleHandler` conforms to the `slog.Handler` interface and uses the correct method signature.
2024-05-14 04:55:33 -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
console_handler.go aider: Fix undefined slog.Field error in console_handler.go by implementing the slog.Handler interface correctly. 2024-05-14 04:55:33 -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: Ensured all handlers conform to slog.Handler interface and removed NewEvent() constructor calls. 2024-05-14 04:54:34 -07:00
Makefile initial 2024-05-13 21:43:47 -07:00
README.md initial 2024-05-13 21:43:47 -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_test.go initial 2024-05-13 21:43:47 -07:00
simplelog.go aider: Ensured all handlers conform to slog.Handler interface and removed NewEvent() constructor calls. 2024-05-14 04:54:34 -07:00
TODO initial 2024-05-13 21:43:47 -07:00
webhook_handler.go aider: Ensured all handlers conform to slog.Handler interface and removed NewEvent() constructor calls. 2024-05-14 04:54:34 -07:00

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