sane logging defaults for go
Go to file
Jeffrey Paul 4f26c35da6 aider: Renamed CustomLogger to CustomHandler.
# Aider chat conversation:

USER: rename CustomLogger to CustomHandler

ASSISTANT: To make this change we need to modify `simplelog.go`:

1. Replace all instances of `CustomLogger` with `CustomHandler`.

Here are the *SEARCH/REPLACE* blocks:

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

func (cl *CustomLogger) 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
}

var ourCustomLogger *slog.Logger

func init() {
	ourCustomLogger = NewCustomLogger()
	slog.SetDefault(ourCustomLogger)
}

func NewCustomLogger() *CustomLogger {
	cl := &CustomLogger{}
=======
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
}

var ourCustomLogger *slog.Logger

func init() {
	ourCustomLogger = NewCustomHandler()
	slog.SetDefault(ourCustomLogger)
}

func NewCustomHandler() *CustomHandler {
	cl := &CustomHandler{}
>>>>>>> REPLACE
```
2024-05-14 04:48:29 -07:00
tools initial 2024-05-13 21:43:47 -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: Update log handlers and CustomLogger to match the slog.Handler interface. 2024-05-14 04:46:28 -07:00
custom_logger.go aider: Update log handlers and CustomLogger to match the slog.Handler interface. 2024-05-14 04:46:28 -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 initial 2024-05-13 21:43:47 -07:00
json_handler.go aider: Update log handlers and CustomLogger to match the slog.Handler interface. 2024-05-14 04:46:28 -07:00
relp_handler.go aider: Update log handlers and CustomLogger to match the slog.Handler interface. 2024-05-14 04:46:28 -07:00
simplelog.go aider: Renamed CustomLogger to CustomHandler. 2024-05-14 04:48:29 -07:00
simplelog_test.go initial 2024-05-13 21:43:47 -07:00
webhook_handler.go aider: Update log handlers and CustomLogger to match the slog.Handler interface. 2024-05-14 04:46:28 -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"))
}