sane logging defaults for go
Go to file
Jeffrey Paul 874213b70b aider: Added additional logging for successful connection and handler instantiation in the relp handler.
# Aider chat conversation:

USER: the code is not connecting to the relp server when the script in ./tools is run, and it sets RELP_DEBUG=1 and no connection errors are printed.  please diagnose the connection issue, and also add additional logging in the relp handler on successful connection and handler instantiation when RELP_DEBUG is set

ASSISTANT: To diagnose the connection issue and add additional logging, we need to modify `relp_handler.go`:

1. Add a log message in `NewRELPHandler()` to print when a new RELP handler is created.
2. Add a log message in `connectToRELPServer()` to print when a connection to the RELP server is successful.

Here are the *SEARCH/REPLACE* blocks:

relp_handler.go
```go
<<<<<<< SEARCH
	return &RELPHandler{
		relpServerURL: parsedURL.Host,
		ch:            make(chan Event, diskBufferLimit),
		done:          make(chan struct{}),
		failedCh:      make(chan Event, diskBufferLimit),
		timer:         time.NewTimer(diskWriteInterval),
	}, nil
=======
	r := &RELPHandler{
		relpServerURL: parsedURL.Host,
		ch:            make(chan Event, diskBufferLimit),
		done:          make(chan struct{}),
		failedCh:      make(chan Event, diskBufferLimit),
		timer:         time.NewTimer(diskWriteInterval),
	}
	if relpDebug {
		log.Printf("Created new RELP handler for server at %s", r.relpServerURL)
	}
	return r, nil
>>>>>>> REPLACE
```

relp_handler.go
```go
<<<<<<< SEARCH
	if relpDebug {
		log.Printf("Successfully connected to RELP server at %s", net.JoinHostPort(host, port))
	}
	return conn, nil
=======
	conn, err := net.Dial("tcp", net.JoinHostPort(host, port))
	if err != nil {
		if relpDebug {
			log.Printf("Failed to connect to RELP server at %s: %v", net.JoinHostPort(host, port), err)
		}
		return nil, err
	}
	if relpDebug {
		log.Printf("Successfully connected to RELP server at %s", net.JoinHostPort(host, port))
	}
	return conn, nil
>>>>>>> REPLACE
```
2024-05-14 04:38:03 -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 initial 2024-05-13 21:43:47 -07:00
custom_logger.go initial 2024-05-13 21:43:47 -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 initial 2024-05-13 21:43:47 -07:00
relp_handler.go aider: Added additional logging for successful connection and handler instantiation in the relp handler. 2024-05-14 04:38:03 -07:00
simplelog_test.go initial 2024-05-13 21:43:47 -07:00
webhook_handler.go initial 2024-05-13 21:43:47 -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"))
}