sane logging defaults for go
Go to file
Jeffrey Paul b0b5c32bb5 aider: Ensure RELPHandler implements slog.Handler interface by adding Enabled, WithAttrs, and WithGroup methods.
# Aider chat conversation:

USER: ../simplelog.go:74:37: cannot use handler (variable of type *RELPHandler) as slog.Handler value in argument to append: *RELPHandler does not implement slog.Handler (missing method Enabled)

ASSISTANT: To fix the issue, we need to ensure that `RELPHandler` implements the `slog.Handler` interface by adding the `Enabled`, `WithAttrs`, and `WithGroup` methods. Here are the *SEARCH/REPLACE* blocks for `relp_handler.go`:

relp_handler.go
```python
<<<<<<< SEARCH
func (r *RELPHandler) Handle(ctx context.Context, record slog.Record) error {
=======
func (r *RELPHandler) Enabled(ctx context.Context, level slog.Level) bool {
	return true
}

func (r *RELPHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
	return r
}

func (r *RELPHandler) WithGroup(name string) slog.Handler {
	return r
}

func (r *RELPHandler) Handle(ctx context.Context, record slog.Record) error {
>>>>>>> REPLACE
```
2024-05-14 05:00:00 -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: Import the `context` package to fix the undefined `context` error in `console_handler.go`. 2024-05-14 04:55:57 -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: Import the `log/slog` package to fix the undefined `slog` error in `json_handler.go`. 2024-05-14 04:57:24 -07:00
relp_handler.go aider: Ensure RELPHandler implements slog.Handler interface by adding Enabled, WithAttrs, and WithGroup methods. 2024-05-14 05:00:00 -07:00
simplelog.go aider: Added missing imports and updated existing imports in multiple files. 2024-05-14 04:57:12 -07:00
simplelog_test.go initial 2024-05-13 21:43:47 -07:00
webhook_handler.go aider: Added missing imports and updated existing imports in multiple files. 2024-05-14 04:57:12 -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"))
}