From d8f35dd031b815d4070623b967e7b0ea47382dc4 Mon Sep 17 00:00:00 2001 From: sneak Date: Mon, 10 Jun 2024 02:39:01 -0700 Subject: [PATCH] closer to ready --- README.md | 14 ++++++++++---- simplelog.go | 6 +++++- tools/relp_log_trial.go | 2 +- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dae78db..bbec684 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # simplelog +## Summary + simplelog is an opinionated logging package designed to facilitate easy and structured logging in Go applications with an absolute minimum of boilerplate. @@ -7,12 +9,16 @@ 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. +## Current Status + +Pre-1.0, not working yet. + ## 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 +- 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 diff --git a/simplelog.go b/simplelog.go index 77b165c..1294256 100644 --- a/simplelog.go +++ b/simplelog.go @@ -2,10 +2,13 @@ package simplelog import ( "context" + "encoding/json" "log" - "runtime" "log/slog" "os" + "time" + + "github.com/google/uuid" "github.com/mattn/go-isatty" ) @@ -81,6 +84,7 @@ func (cl *MultiplexHandler) WithGroup(name string) slog.Handler { } return &MultiplexHandler{handlers: newHandlers} } + type ExtendedEvent interface { GetID() uuid.UUID GetTimestamp() time.Time diff --git a/tools/relp_log_trial.go b/tools/relp_log_trial.go index 15d2184..de140dd 100644 --- a/tools/relp_log_trial.go +++ b/tools/relp_log_trial.go @@ -3,7 +3,7 @@ package main import ( "log/slog" - _ "git.eeqj.de/sneak/go-simplelog" // Using underscore to only invoke init() + _ "sneak.berlin/go/simplelog" // Using underscore to only invoke init() ) func main() {