Compare commits
10 Commits
ea0c84547f
...
test-ci
| Author | SHA1 | Date | |
|---|---|---|---|
| 3c8c83caa8 | |||
| 4abd40d8e2 | |||
| 9121da9aae | |||
| 74ce052b77 | |||
| 1eef38a5fa | |||
| 97a82e9b2c | |||
|
|
869b7ca4c3 | ||
| 31c9ed52cb | |||
| 28d0d041b0 | |||
| 278cb73053 |
12
.gitea/workflows/check.yml
Normal file
12
.gitea/workflows/check.yml
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
name: check
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
- run: docker build .
|
||||||
20
Dockerfile
Normal file
20
Dockerfile
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Lint stage: format check + golangci-lint
|
||||||
|
# golangci-lint v1.64.8 (2025-02-18)
|
||||||
|
FROM golangci/golangci-lint@sha256:2987913e27f4eca9c8a39129d2c7bc1e74fbcf77f181e01cea607be437aa5cb8 AS lint
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
RUN make fmt-check
|
||||||
|
RUN make lint
|
||||||
|
|
||||||
|
# Test stage: run full test suite
|
||||||
|
# golang 1.22.12 (2025-02-04)
|
||||||
|
FROM golang@sha256:1cf6c45ba39db9fd6db16922041d074a63c935556a05c5ccb62d181034df7f02 AS test
|
||||||
|
# Depend on lint stage so both stages always run
|
||||||
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
RUN make test
|
||||||
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.
|
||||||
|
|
||||||
20
Makefile
20
Makefile
@@ -1,6 +1,6 @@
|
|||||||
.PHONY: test
|
.PHONY: test fmt fmt-check lint check docker hooks
|
||||||
|
|
||||||
default: test
|
default: check
|
||||||
|
|
||||||
test:
|
test:
|
||||||
@go test -v ./...
|
@go test -v ./...
|
||||||
@@ -9,6 +9,20 @@ fmt:
|
|||||||
goimports -l -w .
|
goimports -l -w .
|
||||||
golangci-lint run --fix
|
golangci-lint run --fix
|
||||||
|
|
||||||
|
fmt-check:
|
||||||
|
@test -z "$$(gofmt -l .)" || { echo "gofmt would reformat:"; gofmt -l .; exit 1; }
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
golangci-lint run
|
golangci-lint run
|
||||||
sh -c 'test -z "$$(gofmt -l .)"'
|
|
||||||
|
check: fmt-check lint test
|
||||||
|
|
||||||
|
docker:
|
||||||
|
docker build --progress plain .
|
||||||
|
|
||||||
|
hooks:
|
||||||
|
@echo "Installing git hooks..."
|
||||||
|
@mkdir -p .git/hooks
|
||||||
|
@printf '#!/bin/sh\nmake check\n' > .git/hooks/pre-commit
|
||||||
|
@chmod +x .git/hooks/pre-commit
|
||||||
|
@echo "Pre-commit hook installed."
|
||||||
|
|||||||
16
README.md
16
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,8 @@ 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)
|
||||||
|
|
||||||
|
|||||||
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