Compare commits
12 Commits
000fe293ee
...
fix/11-spl
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a5b4c2af0d | ||
| 9121da9aae | |||
| 74ce052b77 | |||
| 1eef38a5fa | |||
| 97a82e9b2c | |||
|
|
869b7ca4c3 | ||
| 31c9ed52cb | |||
| 28d0d041b0 | |||
| 278cb73053 | |||
| ea0c84547f | |||
| a852d938e7 | |||
| a660203e8f |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1 +1,2 @@
|
|||||||
.aider*
|
.aider*
|
||||||
|
cmd/example/example
|
||||||
|
|||||||
27
Dockerfile
Normal file
27
Dockerfile
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# Lint stage — fast feedback on formatting and lint issues
|
||||||
|
# golangci/golangci-lint:v1.64.8
|
||||||
|
FROM golangci/golangci-lint@sha256:2987913e27f4eca9c8a39129d2c7bc1e74fbcf77f181e01cea607be437aa5cb8 AS lint
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
RUN golangci-lint run
|
||||||
|
RUN sh -c 'test -z "$(gofmt -l .)"'
|
||||||
|
|
||||||
|
# Test stage — run tests
|
||||||
|
# golang:1.22
|
||||||
|
FROM golang@sha256:1cf6c45ba39db9fd6db16922041d074a63c935556a05c5ccb62d181034df7f02 AS test
|
||||||
|
WORKDIR /src
|
||||||
|
# Force BuildKit to run the lint stage by creating a stage dependency
|
||||||
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
RUN go test -v ./...
|
||||||
|
|
||||||
|
# Final stage: Combine the linting and testing stages
|
||||||
|
# golang:1.22
|
||||||
|
FROM golang@sha256:1cf6c45ba39db9fd6db16922041d074a63c935556a05c5ccb62d181034df7f02 AS final
|
||||||
|
WORKDIR /app
|
||||||
|
COPY --from=test /src/go.mod ./
|
||||||
|
CMD ["echo", "Build and tests passed successfully!"]
|
||||||
14
LICENSE
Normal file
14
LICENSE
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
||||||
|
Version 2, December 2004
|
||||||
|
|
||||||
|
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim or modified
|
||||||
|
copies of this license document, and changing it is allowed as long
|
||||||
|
as the name is changed.
|
||||||
|
|
||||||
|
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
||||||
|
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||||
|
|
||||||
|
0. You just DO WHAT THE FUCK YOU WANT TO.
|
||||||
|
|
||||||
3
Makefile
3
Makefile
@@ -12,3 +12,6 @@ fmt:
|
|||||||
lint:
|
lint:
|
||||||
golangci-lint run
|
golangci-lint run
|
||||||
sh -c 'test -z "$$(gofmt -l .)"'
|
sh -c 'test -z "$$(gofmt -l .)"'
|
||||||
|
|
||||||
|
docker:
|
||||||
|
docker build --progress plain .
|
||||||
|
|||||||
15
README.md
15
README.md
@@ -11,15 +11,18 @@ stdlib `log/slog` default handler, and solve the 90% case for logging.
|
|||||||
|
|
||||||
## Current Status
|
## Current Status
|
||||||
|
|
||||||
Pre-1.0, not working yet.
|
Released v1.0.0 2024-06-14. Works as intended. No known bugs.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- if output is a tty, outputs pretty color logs
|
- if output is a tty, outputs pretty color logs
|
||||||
- if output is not a tty, outputs json
|
- 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
|
- supports delivering each log message via a webhook
|
||||||
|
|
||||||
|
## Planned Features
|
||||||
|
|
||||||
|
- supports delivering logs via tcp RELP (e.g. to remote rsyslog using imrelp)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
To use simplelog, first ensure your project is set up with Go modules:
|
To use simplelog, first ensure your project is set up with Go modules:
|
||||||
@@ -36,7 +39,9 @@ go get sneak.berlin/go/simplelog
|
|||||||
|
|
||||||
## Usage
|
## 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.
|
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.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
package main
|
||||||
@@ -54,3 +59,7 @@ func main() {
|
|||||||
slog.Error("Failed to save data", slog.String("reason", "permission denied"))
|
slog.Error("Failed to save data", slog.String("reason", "permission denied"))
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[WTFPL](./LICENSE)
|
||||||
|
|||||||
26
cmd/example/main.go
Normal file
26
cmd/example/main.go
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log/slog"
|
||||||
|
|
||||||
|
_ "sneak.berlin/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"),
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -16,7 +16,10 @@ func NewConsoleHandler() *ConsoleHandler {
|
|||||||
return &ConsoleHandler{}
|
return &ConsoleHandler{}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *ConsoleHandler) Handle(ctx context.Context, record slog.Record) error {
|
func (c *ConsoleHandler) Handle(
|
||||||
|
ctx context.Context,
|
||||||
|
record slog.Record,
|
||||||
|
) error {
|
||||||
timestamp := time.Now().UTC().Format("2006-01-02T15:04:05.000Z07:00")
|
timestamp := time.Now().UTC().Format("2006-01-02T15:04:05.000Z07:00")
|
||||||
var colorFunc func(format string, a ...interface{}) string
|
var colorFunc func(format string, a ...interface{}) string
|
||||||
|
|
||||||
@@ -32,16 +35,28 @@ func (c *ConsoleHandler) Handle(ctx context.Context, record slog.Record) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Get the caller information
|
// Get the caller information
|
||||||
_, file, line, ok := runtime.Caller(5)
|
_, file, line, ok := runtime.Caller(4)
|
||||||
if !ok {
|
if !ok {
|
||||||
file = "???"
|
file = "???"
|
||||||
line = 0
|
line = 0
|
||||||
}
|
}
|
||||||
fmt.Println(colorFunc("%s [%s] %s:%d: %s", timestamp, record.Level, file, line, record.Message))
|
fmt.Println(
|
||||||
|
colorFunc(
|
||||||
|
"%s [%s] %s:%d: %s",
|
||||||
|
timestamp,
|
||||||
|
record.Level,
|
||||||
|
file,
|
||||||
|
line,
|
||||||
|
record.Message,
|
||||||
|
),
|
||||||
|
)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *ConsoleHandler) Enabled(ctx context.Context, level slog.Level) bool {
|
func (c *ConsoleHandler) Enabled(
|
||||||
|
ctx context.Context,
|
||||||
|
level slog.Level,
|
||||||
|
) bool {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
1
event.go
1
event.go
@@ -15,7 +15,6 @@ type Event struct {
|
|||||||
Data json.RawMessage `json:"data"`
|
Data json.RawMessage `json:"data"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
func NewEvent(level, message string, data json.RawMessage) Event {
|
func NewEvent(level, message string, data json.RawMessage) Event {
|
||||||
return Event{
|
return Event{
|
||||||
ID: uuid.New(),
|
ID: uuid.New(),
|
||||||
|
|||||||
@@ -3,8 +3,9 @@ package simplelog
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"log"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"os"
|
||||||
)
|
)
|
||||||
|
|
||||||
type JSONHandler struct{}
|
type JSONHandler struct{}
|
||||||
@@ -15,7 +16,7 @@ func NewJSONHandler() *JSONHandler {
|
|||||||
|
|
||||||
func (j *JSONHandler) Handle(ctx context.Context, record slog.Record) error {
|
func (j *JSONHandler) Handle(ctx context.Context, record slog.Record) error {
|
||||||
jsonData, _ := json.Marshal(record)
|
jsonData, _ := json.Marshal(record)
|
||||||
log.Println(string(jsonData))
|
fmt.Fprintln(os.Stdout, string(jsonData))
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
33
json_handler_test.go
Normal file
33
json_handler_test.go
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
package simplelog
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log/slog"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestJSONHandlerDeadlock verifies that JSONHandler.Handle does not deadlock
|
||||||
|
// when the default slog handler routes log.Println back through slog.
|
||||||
|
// On the unfixed code this test will hang (deadlock); with the fix it completes.
|
||||||
|
func TestJSONHandlerDeadlock(t *testing.T) {
|
||||||
|
handler := NewJSONHandler()
|
||||||
|
|
||||||
|
// Set our handler as the default so log.Println routes through slog
|
||||||
|
logger := slog.New(handler)
|
||||||
|
slog.SetDefault(logger)
|
||||||
|
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
// This call deadlocks on unfixed code because Handle() calls
|
||||||
|
// log.Println() which re-enters slog → Handle() → log.Println() …
|
||||||
|
slog.Info("test message")
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
// success
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("JSONHandler.Handle deadlocked: timed out after 5 seconds")
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user