mirror of
https://github.com/taigrr/log-socket
synced 2026-03-20 14:52:27 -07:00
Compare commits
1 Commits
v2.4.0
...
cd/6-add-b
| Author | SHA1 | Date | |
|---|---|---|---|
| 085aadaaef |
35
README.md
35
README.md
@@ -15,7 +15,6 @@ A real-time log viewer with WebSocket support and namespace filtering, written i
|
||||
- **Namespace filtering**: Subscribe to specific namespaces via WebSocket
|
||||
- **Frontend namespace selector**: Filter logs by namespace in the web UI
|
||||
- **Namespace API**: GET `/api/namespaces` to list all active namespaces
|
||||
- **Colored terminal output**: Log levels are color-coded in terminal (no external packages)
|
||||
|
||||
## Features
|
||||
|
||||
@@ -189,40 +188,6 @@ ws://localhost:8080/ws?namespaces=api,database # Multiple namespaces
|
||||
- **Color Coding**: Different log levels are color-coded
|
||||
- **Reconnect**: Reconnect WebSocket with new namespace filter
|
||||
|
||||
## Terminal Colors
|
||||
|
||||
Log output to stderr is automatically colorized when writing to a terminal. Colors are disabled when output is piped or redirected to a file.
|
||||
|
||||
### Color Scheme
|
||||
|
||||
| Level | Color |
|
||||
|--------|--------------|
|
||||
| TRACE | Gray |
|
||||
| DEBUG | Cyan |
|
||||
| INFO | Green |
|
||||
| NOTICE | Blue |
|
||||
| WARN | Yellow |
|
||||
| ERROR | Red |
|
||||
| PANIC | Bold Red |
|
||||
| FATAL | Bold Red |
|
||||
|
||||
### Controlling Colors
|
||||
|
||||
```go
|
||||
// Disable colors (e.g., for CI/CD or file output)
|
||||
logger.SetColorEnabled(false)
|
||||
|
||||
// Enable colors explicitly
|
||||
logger.SetColorEnabled(true)
|
||||
|
||||
// Check current state
|
||||
if logger.ColorEnabled() {
|
||||
// colors are on
|
||||
}
|
||||
```
|
||||
|
||||
Colors are implemented using standard ANSI escape codes with no external dependencies.
|
||||
|
||||
## Migration from v1
|
||||
|
||||
### Import Path
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
// Example: basic usage of log-socket as a drop-in logger.
|
||||
//
|
||||
// This demonstrates using the package-level logging functions,
|
||||
// which work similarly to the standard library's log package.
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
|
||||
"github.com/taigrr/log-socket/v2/browser"
|
||||
logger "github.com/taigrr/log-socket/v2/log"
|
||||
"github.com/taigrr/log-socket/v2/ws"
|
||||
)
|
||||
|
||||
func main() {
|
||||
defer logger.Flush()
|
||||
|
||||
// Set the minimum log level (default is LTrace, showing everything)
|
||||
logger.SetLogLevel(logger.LDebug)
|
||||
|
||||
// Package-level functions log to the "default" namespace
|
||||
logger.Info("Application starting up")
|
||||
logger.Debug("Debug mode enabled")
|
||||
logger.Warnf("Config file not found at %s, using defaults", "/etc/app/config.yaml")
|
||||
logger.Errorf("Failed to connect to database: %s", "connection refused")
|
||||
|
||||
// Print/Printf/Println are aliases for Info
|
||||
logger.Println("This is equivalent to Infoln")
|
||||
|
||||
// Start the web UI so you can view logs at http://localhost:8080
|
||||
http.HandleFunc("/ws", ws.LogSocketHandler)
|
||||
http.HandleFunc("/", browser.LogSocketViewHandler)
|
||||
fmt.Println("Log viewer available at http://localhost:8080")
|
||||
logger.Fatal(http.ListenAndServe("0.0.0.0:8080", nil))
|
||||
}
|
||||
@@ -1,63 +0,0 @@
|
||||
// Example: programmatic log client with namespace filtering.
|
||||
//
|
||||
// This shows how to create a Client that receives log entries
|
||||
// programmatically, optionally filtered to specific namespaces.
|
||||
// Useful for building custom log processors, alerting, or forwarding.
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
logger "github.com/taigrr/log-socket/v2/log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
defer logger.Flush()
|
||||
|
||||
// Create a client that receives ALL log entries
|
||||
allLogs := logger.CreateClient()
|
||||
allLogs.SetLogLevel(logger.LInfo)
|
||||
|
||||
// Create a client that only receives "database" and "auth" logs
|
||||
securityLogs := logger.CreateClient("database", "auth")
|
||||
securityLogs.SetLogLevel(logger.LWarn) // Only warnings and above
|
||||
|
||||
dbLog := logger.NewLogger("database")
|
||||
authLog := logger.NewLogger("auth")
|
||||
apiLog := logger.NewLogger("api")
|
||||
|
||||
// Process all logs
|
||||
go func() {
|
||||
for {
|
||||
entry := allLogs.Get()
|
||||
fmt.Printf("[ALL] %s [%s] %s: %s\n",
|
||||
entry.Timestamp.Format(time.TimeOnly),
|
||||
entry.Namespace, entry.Level, entry.Output)
|
||||
}
|
||||
}()
|
||||
|
||||
// Process only security-relevant warnings/errors
|
||||
go func() {
|
||||
for {
|
||||
entry := securityLogs.Get()
|
||||
if entry.Level == "ERROR" || entry.Level == "WARN" {
|
||||
fmt.Printf("🚨 SECURITY ALERT [%s] %s: %s\n",
|
||||
entry.Namespace, entry.Level, entry.Output)
|
||||
}
|
||||
}
|
||||
}()
|
||||
|
||||
// Generate some logs
|
||||
for i := 0; i < 5; i++ {
|
||||
apiLog.Info("API request processed")
|
||||
dbLog.Info("Query executed successfully")
|
||||
dbLog.Warn("Connection pool running low")
|
||||
authLog.Error("Brute force attempt detected")
|
||||
time.Sleep(1 * time.Second)
|
||||
}
|
||||
|
||||
// Clean up clients when done
|
||||
allLogs.Destroy()
|
||||
securityLogs.Destroy()
|
||||
}
|
||||
@@ -1,48 +0,0 @@
|
||||
// Example: log level filtering and all available levels.
|
||||
//
|
||||
// log-socket supports 8 log levels from TRACE (most verbose)
|
||||
// to FATAL (least verbose). Setting a log level filters out
|
||||
// everything below it.
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
logger "github.com/taigrr/log-socket/v2/log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
defer logger.Flush()
|
||||
|
||||
fmt.Println("=== All log levels (TRACE and above) ===")
|
||||
logger.SetLogLevel(logger.LTrace)
|
||||
|
||||
logger.Trace("Detailed execution trace — variable x = 42")
|
||||
logger.Debug("Processing request for user_id=123")
|
||||
logger.Info("Server started on :8080")
|
||||
logger.Notice("Configuration reloaded")
|
||||
logger.Warn("Disk usage at 85%")
|
||||
logger.Error("Failed to send email: SMTP timeout")
|
||||
// logger.Panic("...") — would panic
|
||||
// logger.Fatal("...") — would os.Exit(1)
|
||||
|
||||
fmt.Println("\n=== Formatted variants ===")
|
||||
logger.Infof("Request took %dms", 42)
|
||||
logger.Warnf("Retrying in %d seconds (attempt %d/%d)", 5, 2, 3)
|
||||
logger.Errorf("HTTP %d: %s", 503, "Service Unavailable")
|
||||
|
||||
fmt.Println("\n=== Only WARN and above ===")
|
||||
logger.SetLogLevel(logger.LWarn)
|
||||
|
||||
logger.Debug("This will NOT appear")
|
||||
logger.Info("This will NOT appear either")
|
||||
logger.Warn("This WILL appear")
|
||||
logger.Error("This WILL appear too")
|
||||
|
||||
fmt.Println("\n=== Per-logger levels via namespaced loggers ===")
|
||||
logger.SetLogLevel(logger.LTrace) // Reset global
|
||||
|
||||
appLog := logger.NewLogger("app")
|
||||
appLog.Info("Namespaced loggers inherit the global output but tag entries")
|
||||
appLog.Warnf("Something needs attention in the %s subsystem", "app")
|
||||
}
|
||||
@@ -1,73 +0,0 @@
|
||||
// Example: namespace-based logging for organizing logs by component.
|
||||
//
|
||||
// Namespaces let you tag log entries by subsystem (api, database, auth, etc.)
|
||||
// and filter them in the web UI or via programmatic clients.
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"math/rand"
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
"github.com/taigrr/log-socket/v2/browser"
|
||||
logger "github.com/taigrr/log-socket/v2/log"
|
||||
"github.com/taigrr/log-socket/v2/ws"
|
||||
)
|
||||
|
||||
func main() {
|
||||
defer logger.Flush()
|
||||
|
||||
// Create loggers for different subsystems
|
||||
apiLog := logger.NewLogger("api")
|
||||
dbLog := logger.NewLogger("database")
|
||||
authLog := logger.NewLogger("auth")
|
||||
cacheLog := logger.NewLogger("cache")
|
||||
|
||||
// Simulate application activity
|
||||
go func() {
|
||||
for {
|
||||
apiLog.Infof("GET /api/users — 200 OK (%dms)", rand.Intn(200))
|
||||
apiLog.Debugf("Request headers: Accept=application/json")
|
||||
time.Sleep(1 * time.Second)
|
||||
}
|
||||
}()
|
||||
|
||||
go func() {
|
||||
for {
|
||||
dbLog.Infof("SELECT * FROM users — %d rows", rand.Intn(100))
|
||||
if rand.Float64() < 0.3 {
|
||||
dbLog.Warn("Slow query detected (>500ms)")
|
||||
}
|
||||
time.Sleep(2 * time.Second)
|
||||
}
|
||||
}()
|
||||
|
||||
go func() {
|
||||
for {
|
||||
if rand.Float64() < 0.7 {
|
||||
authLog.Info("User login successful")
|
||||
} else {
|
||||
authLog.Error("Failed login attempt from 192.168.1.42")
|
||||
}
|
||||
time.Sleep(3 * time.Second)
|
||||
}
|
||||
}()
|
||||
|
||||
go func() {
|
||||
for {
|
||||
cacheLog.Tracef("Cache hit ratio: %.1f%%", rand.Float64()*100)
|
||||
if rand.Float64() < 0.1 {
|
||||
cacheLog.Warn("Cache eviction triggered")
|
||||
}
|
||||
time.Sleep(5 * time.Second)
|
||||
}
|
||||
}()
|
||||
|
||||
// The /api/namespaces endpoint lists all active namespaces
|
||||
http.HandleFunc("/ws", ws.LogSocketHandler)
|
||||
http.HandleFunc("/api/namespaces", ws.NamespacesHandler)
|
||||
http.HandleFunc("/", browser.LogSocketViewHandler)
|
||||
fmt.Println("Log viewer with namespace filtering at http://localhost:8080")
|
||||
logger.Fatal(http.ListenAndServe("0.0.0.0:8080", nil))
|
||||
}
|
||||
2
go.mod
2
go.mod
@@ -1,5 +1,5 @@
|
||||
module github.com/taigrr/log-socket/v2
|
||||
|
||||
go 1.26.0
|
||||
go 1.25.4
|
||||
|
||||
require github.com/gorilla/websocket v1.5.3
|
||||
|
||||
@@ -1,171 +0,0 @@
|
||||
package log
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
)
|
||||
|
||||
const benchNS = "bench-isolated-ns"
|
||||
|
||||
// benchClient creates a client with a continuous drain goroutine.
|
||||
// Returns the client and a stop function to call after b.StopTimer().
|
||||
func benchClient(ns string) (*Client, func()) {
|
||||
c := CreateClient(ns)
|
||||
c.SetLogLevel(LTrace)
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
for {
|
||||
select {
|
||||
case <-done:
|
||||
return
|
||||
case <-c.writer:
|
||||
}
|
||||
}
|
||||
}()
|
||||
return c, func() {
|
||||
close(done)
|
||||
c.Destroy()
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkCreateClient measures client creation overhead.
|
||||
func BenchmarkCreateClient(b *testing.B) {
|
||||
for i := 0; i < b.N; i++ {
|
||||
c := CreateClient("bench")
|
||||
c.Destroy()
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkTrace benchmarks Logger.Trace.
|
||||
func BenchmarkTrace(b *testing.B) {
|
||||
l := NewLogger(benchNS)
|
||||
_, stop := benchClient(benchNS)
|
||||
defer stop()
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
l.Trace("benchmark trace message")
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkTracef benchmarks formatted Logger.Tracef.
|
||||
func BenchmarkTracef(b *testing.B) {
|
||||
l := NewLogger(benchNS)
|
||||
_, stop := benchClient(benchNS)
|
||||
defer stop()
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
l.Tracef("benchmark trace message %d", i)
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkDebug benchmarks Logger.Debug.
|
||||
func BenchmarkDebug(b *testing.B) {
|
||||
l := NewLogger(benchNS)
|
||||
_, stop := benchClient(benchNS)
|
||||
defer stop()
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
l.Debug("benchmark debug message")
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkInfo benchmarks Logger.Info.
|
||||
func BenchmarkInfo(b *testing.B) {
|
||||
l := NewLogger(benchNS)
|
||||
_, stop := benchClient(benchNS)
|
||||
defer stop()
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
l.Info("benchmark info message")
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkInfof benchmarks Logger.Infof with formatting.
|
||||
func BenchmarkInfof(b *testing.B) {
|
||||
l := NewLogger(benchNS)
|
||||
_, stop := benchClient(benchNS)
|
||||
defer stop()
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
l.Infof("user %s performed action %d", "testuser", i)
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkWarn benchmarks Logger.Warn.
|
||||
func BenchmarkWarn(b *testing.B) {
|
||||
l := NewLogger(benchNS)
|
||||
_, stop := benchClient(benchNS)
|
||||
defer stop()
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
l.Warn("benchmark warn message")
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkError benchmarks Logger.Error.
|
||||
func BenchmarkError(b *testing.B) {
|
||||
l := NewLogger(benchNS)
|
||||
_, stop := benchClient(benchNS)
|
||||
defer stop()
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
l.Error("benchmark error message")
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkMultipleClients measures fan-out to multiple consumers.
|
||||
func BenchmarkMultipleClients(b *testing.B) {
|
||||
const numClients = 5
|
||||
l := NewLogger(benchNS)
|
||||
stops := make([]func(), numClients)
|
||||
for i := range stops {
|
||||
_, stops[i] = benchClient(benchNS)
|
||||
}
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
l.Info("benchmark multi-client")
|
||||
}
|
||||
b.StopTimer()
|
||||
for _, stop := range stops {
|
||||
stop()
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkParallelInfo benchmarks concurrent Info calls from multiple goroutines.
|
||||
func BenchmarkParallelInfo(b *testing.B) {
|
||||
l := NewLogger(benchNS)
|
||||
_, stop := benchClient(benchNS)
|
||||
defer stop()
|
||||
b.ResetTimer()
|
||||
b.RunParallel(func(pb *testing.PB) {
|
||||
for pb.Next() {
|
||||
l.Info("parallel benchmark info")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// BenchmarkNamespaceFiltering benchmarks logging when the consumer
|
||||
// filters by a different namespace (messages are not delivered).
|
||||
func BenchmarkNamespaceFiltering(b *testing.B) {
|
||||
l := NewLogger(benchNS)
|
||||
_, stop := benchClient("completely-different-ns")
|
||||
defer stop()
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
l.Info("filtered out message")
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkFileInfo measures the cost of runtime.Caller for file info.
|
||||
func BenchmarkFileInfo(b *testing.B) {
|
||||
for i := 0; i < b.N; i++ {
|
||||
fileInfo(1)
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkEntryCreation measures raw fmt.Sprint overhead (baseline).
|
||||
func BenchmarkEntryCreation(b *testing.B) {
|
||||
for i := 0; i < b.N; i++ {
|
||||
_ = fmt.Sprint("benchmark message ", i)
|
||||
}
|
||||
}
|
||||
389
log/benchmark_test.go
Normal file
389
log/benchmark_test.go
Normal file
@@ -0,0 +1,389 @@
|
||||
package log
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
// drainClient continuously reads from a client to prevent blocking.
|
||||
// Returns a function to stop draining and wait for completion.
|
||||
func drainClient(c *Client) func() {
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
for {
|
||||
select {
|
||||
case <-done:
|
||||
return
|
||||
case <-c.writer:
|
||||
// Drain entries
|
||||
}
|
||||
}
|
||||
}()
|
||||
return func() { close(done) }
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Serial Benchmarks - Single Log Levels
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
func BenchmarkTrace(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LTrace)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Trace("benchmark message")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkDebug(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LDebug)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Debug("benchmark message")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkInfo(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Info("benchmark message")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkNotice(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LNotice)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Notice("benchmark message")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkWarn(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LWarn)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Warn("benchmark message")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkError(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LError)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Error("benchmark message")
|
||||
}
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Formatted Logging Benchmarks
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
func BenchmarkDebugf(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LDebug)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Debugf("benchmark message %d with %s", i, "formatting")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkInfof(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Infof("benchmark message %d with %s", i, "formatting")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkErrorf(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LError)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Errorf("benchmark message %d with %s", i, "formatting")
|
||||
}
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Parallel Benchmarks
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
func BenchmarkDebugParallel(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LDebug)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
b.RunParallel(func(pb *testing.PB) {
|
||||
for pb.Next() {
|
||||
Debug("parallel benchmark message")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func BenchmarkInfoParallel(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
b.RunParallel(func(pb *testing.PB) {
|
||||
for pb.Next() {
|
||||
Info("parallel benchmark message")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func BenchmarkInfofParallel(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
b.RunParallel(func(pb *testing.PB) {
|
||||
counter := 0
|
||||
for pb.Next() {
|
||||
Infof("parallel benchmark message %d", counter)
|
||||
counter++
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Logger Instance Benchmarks (Namespaced Logging)
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
func BenchmarkLoggerInfo(b *testing.B) {
|
||||
logger := NewLogger("benchmark")
|
||||
c := CreateClient("benchmark")
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
logger.Info("benchmark message")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkLoggerInfof(b *testing.B) {
|
||||
logger := NewLogger("benchmark")
|
||||
c := CreateClient("benchmark")
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
logger.Infof("benchmark message %d", i)
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkLoggerDebugParallel(b *testing.B) {
|
||||
logger := NewLogger("benchmark")
|
||||
c := CreateClient("benchmark")
|
||||
c.SetLogLevel(LDebug)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
b.RunParallel(func(pb *testing.PB) {
|
||||
for pb.Next() {
|
||||
logger.Debug("parallel benchmark message")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Multiple Client Benchmarks
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
func BenchmarkMultipleClients(b *testing.B) {
|
||||
const numClients = 5
|
||||
var clients []*Client
|
||||
var stopFuncs []func()
|
||||
|
||||
for i := 0; i < numClients; i++ {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
clients = append(clients, c)
|
||||
stopFuncs = append(stopFuncs, stop)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
for i, c := range clients {
|
||||
stopFuncs[i]()
|
||||
c.Destroy()
|
||||
}
|
||||
}()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Info("benchmark message to multiple clients")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkMultipleNamespaces(b *testing.B) {
|
||||
namespaces := []string{"auth", "db", "api", "cache", "queue"}
|
||||
var loggers []*Logger
|
||||
var clients []*Client
|
||||
var stopFuncs []func()
|
||||
|
||||
for _, ns := range namespaces {
|
||||
loggers = append(loggers, NewLogger(ns))
|
||||
c := CreateClient(ns)
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
clients = append(clients, c)
|
||||
stopFuncs = append(stopFuncs, stop)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
for i, c := range clients {
|
||||
stopFuncs[i]()
|
||||
c.Destroy()
|
||||
}
|
||||
}()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
loggers[i%len(loggers)].Info("benchmark message")
|
||||
}
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// With Synchronous Client Consumption (Legacy Pattern)
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
// BenchmarkDebugWithSyncConsumer measures the overhead of synchronous consumption
|
||||
// using the Get() method, processing one message at a time.
|
||||
func BenchmarkDebugWithSyncConsumer(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LDebug)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
// This benchmark measures just the logging side with async draining.
|
||||
// For sync consumption patterns, see the TestOrder test.
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Debug("benchmark message")
|
||||
}
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Comparison Benchmarks (Different Message Sizes)
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
func BenchmarkInfoShortMessage(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Info("ok")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkInfoMediumMessage(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
msg := "This is a medium-length log message for benchmarking purposes"
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Info(msg)
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkInfoLongMessage(b *testing.B) {
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LInfo)
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
msg := "This is a much longer log message that simulates real-world logging scenarios where developers tend to include more context about what the application is doing, including variable values, request IDs, and other debugging information that can be quite verbose"
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Info(msg)
|
||||
}
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Overhead Benchmarks (Level Filtering)
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
func BenchmarkDebugFilteredByLevel(b *testing.B) {
|
||||
// No client with Debug level, so Debug logs won't be consumed
|
||||
// This measures the overhead of creating log entries that get filtered
|
||||
c := CreateClient(DefaultNamespace)
|
||||
c.SetLogLevel(LError) // Only Error and above
|
||||
stop := drainClient(c)
|
||||
defer stop()
|
||||
defer c.Destroy()
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
Debug("this message will be filtered")
|
||||
}
|
||||
}
|
||||
99
log/color.go
99
log/color.go
@@ -1,99 +0,0 @@
|
||||
package log
|
||||
|
||||
import (
|
||||
"os"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// ANSI color codes for terminal output
|
||||
const (
|
||||
colorReset = "\033[0m"
|
||||
colorRed = "\033[31m"
|
||||
colorGreen = "\033[32m"
|
||||
colorYellow = "\033[33m"
|
||||
colorBlue = "\033[34m"
|
||||
colorPurple = "\033[35m"
|
||||
colorCyan = "\033[36m"
|
||||
colorWhite = "\033[37m"
|
||||
colorGray = "\033[90m"
|
||||
|
||||
// Bold variants
|
||||
colorBoldRed = "\033[1;31m"
|
||||
colorBoldYellow = "\033[1;33m"
|
||||
colorBoldWhite = "\033[1;37m"
|
||||
)
|
||||
|
||||
var (
|
||||
colorEnabled = true
|
||||
colorEnabledOnce sync.Once
|
||||
colorMux sync.RWMutex
|
||||
)
|
||||
|
||||
// SetColorEnabled enables or disables colored output for stderr logging.
|
||||
// By default, color is enabled when stderr is a terminal.
|
||||
func SetColorEnabled(enabled bool) {
|
||||
colorMux.Lock()
|
||||
colorEnabled = enabled
|
||||
colorMux.Unlock()
|
||||
}
|
||||
|
||||
// ColorEnabled returns whether colored output is currently enabled.
|
||||
func ColorEnabled() bool {
|
||||
colorMux.RLock()
|
||||
defer colorMux.RUnlock()
|
||||
return colorEnabled
|
||||
}
|
||||
|
||||
// isTerminal checks if the given file descriptor is a terminal.
|
||||
// This is a simple heuristic that works on Unix-like systems.
|
||||
func isTerminal(f *os.File) bool {
|
||||
stat, err := f.Stat()
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
return (stat.Mode() & os.ModeCharDevice) != 0
|
||||
}
|
||||
|
||||
// initColorEnabled sets the default color state based on whether stderr is a terminal.
|
||||
func initColorEnabled() {
|
||||
colorEnabledOnce.Do(func() {
|
||||
colorEnabled = isTerminal(os.Stderr)
|
||||
})
|
||||
}
|
||||
|
||||
// levelColor returns the ANSI color code for a given log level.
|
||||
func levelColor(level Level) string {
|
||||
switch level {
|
||||
case LTrace:
|
||||
return colorGray
|
||||
case LDebug:
|
||||
return colorCyan
|
||||
case LInfo:
|
||||
return colorGreen
|
||||
case LNotice:
|
||||
return colorBlue
|
||||
case LWarn:
|
||||
return colorYellow
|
||||
case LError:
|
||||
return colorRed
|
||||
case LPanic:
|
||||
return colorBoldRed
|
||||
case LFatal:
|
||||
return colorBoldRed
|
||||
default:
|
||||
return colorReset
|
||||
}
|
||||
}
|
||||
|
||||
// colorize wraps text with ANSI color codes if color is enabled.
|
||||
func colorize(text string, color string) string {
|
||||
if !ColorEnabled() {
|
||||
return text
|
||||
}
|
||||
return color + text + colorReset
|
||||
}
|
||||
|
||||
// colorizeLevelText returns the level string with appropriate color.
|
||||
func colorizeLevelText(level string, lvl Level) string {
|
||||
return colorize(level, levelColor(lvl))
|
||||
}
|
||||
57
log/log.go
57
log/log.go
@@ -22,8 +22,7 @@ var (
|
||||
|
||||
func init() {
|
||||
namespaces = make(map[string]bool)
|
||||
initColorEnabled()
|
||||
stderrClient = CreateClient()
|
||||
stderrClient = CreateClient(DefaultNamespace)
|
||||
stderrClient.SetLogLevel(LTrace)
|
||||
stderrFinished = make(chan bool, 1)
|
||||
go stderrClient.logStdErr()
|
||||
@@ -32,10 +31,7 @@ func init() {
|
||||
func (c *Client) logStdErr() {
|
||||
for e := range c.writer {
|
||||
if e.level >= c.LogLevel && c.matchesNamespace(e.Namespace) {
|
||||
levelStr := colorizeLevelText(e.Level, e.level)
|
||||
nsStr := colorize("["+e.Namespace+"]", colorPurple)
|
||||
fileStr := colorize(e.File, colorGray)
|
||||
fmt.Fprintf(os.Stderr, "%s\t%s\t%s\t%s\t%s\n", e.Timestamp.String(), levelStr, nsStr, e.Output, fileStr)
|
||||
fmt.Fprintf(os.Stderr, "%s\t%s\t[%s]\t%s\t%s\n", e.Timestamp.String(), e.Level, e.Namespace, e.Output, e.File)
|
||||
}
|
||||
}
|
||||
stderrFinished <- true
|
||||
@@ -74,19 +70,19 @@ func Flush() {
|
||||
}
|
||||
|
||||
func (c *Client) Destroy() error {
|
||||
var otherClients []*Client
|
||||
if !c.initialized {
|
||||
panic(errors.New("cannot delete uninitialized client, did you use CreateClient?"))
|
||||
}
|
||||
sliceTex.Lock()
|
||||
c.writer = nil
|
||||
c.initialized = false
|
||||
var otherClients []*Client
|
||||
for _, x := range clients {
|
||||
if x != c && x.initialized {
|
||||
if x.initialized {
|
||||
otherClients = append(otherClients, x)
|
||||
}
|
||||
}
|
||||
clients = otherClients
|
||||
c.writer = nil
|
||||
sliceTex.Unlock()
|
||||
return nil
|
||||
}
|
||||
@@ -107,9 +103,6 @@ func createLog(e Entry) {
|
||||
sliceTex.Lock()
|
||||
for _, c := range clients {
|
||||
func(c *Client, e Entry) {
|
||||
if c.writer == nil || !c.initialized {
|
||||
return
|
||||
}
|
||||
// Filter by namespace if client has filters specified
|
||||
if !c.matchesNamespace(e.Namespace) {
|
||||
return
|
||||
@@ -424,7 +417,7 @@ func Panic(args ...any) {
|
||||
Namespace: DefaultNamespace,
|
||||
}
|
||||
createLog(e)
|
||||
if len(args) > 0 {
|
||||
if len(args) >= 0 {
|
||||
switch args[0].(type) {
|
||||
case error:
|
||||
panic(args[0])
|
||||
@@ -448,7 +441,7 @@ func Panicf(format string, args ...any) {
|
||||
Namespace: DefaultNamespace,
|
||||
}
|
||||
createLog(e)
|
||||
if len(args) > 0 {
|
||||
if len(args) >= 0 {
|
||||
switch args[0].(type) {
|
||||
case error:
|
||||
panic(args[0])
|
||||
@@ -471,7 +464,7 @@ func Panicln(args ...any) {
|
||||
Namespace: DefaultNamespace,
|
||||
}
|
||||
createLog(e)
|
||||
if len(args) > 0 {
|
||||
if len(args) >= 0 {
|
||||
switch args[0].(type) {
|
||||
case error:
|
||||
panic(args[0])
|
||||
@@ -556,37 +549,3 @@ func fileInfo(skip int) string {
|
||||
}
|
||||
return fmt.Sprintf("%s:%d", file, line)
|
||||
}
|
||||
|
||||
// Broadcast sends an [Entry] to all registered clients. This is the public
|
||||
// entry point used by adapter packages (such as the slog handler) that
|
||||
// construct entries themselves. The unexported level field is inferred from
|
||||
// [Entry.Level] when not already set.
|
||||
func Broadcast(e Entry) {
|
||||
if e.level == 0 && e.Level != "" && e.Level != "TRACE" {
|
||||
e.level = parseLevelString(e.Level)
|
||||
}
|
||||
createLog(e)
|
||||
}
|
||||
|
||||
func parseLevelString(s string) Level {
|
||||
switch s {
|
||||
case "TRACE":
|
||||
return LTrace
|
||||
case "DEBUG":
|
||||
return LDebug
|
||||
case "INFO":
|
||||
return LInfo
|
||||
case "NOTICE":
|
||||
return LNotice
|
||||
case "WARN":
|
||||
return LWarn
|
||||
case "ERROR":
|
||||
return LError
|
||||
case "PANIC":
|
||||
return LPanic
|
||||
case "FATAL":
|
||||
return LFatal
|
||||
default:
|
||||
return LInfo
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,7 +2,6 @@ package log
|
||||
|
||||
import (
|
||||
"strconv"
|
||||
"sync"
|
||||
"testing"
|
||||
)
|
||||
|
||||
@@ -37,21 +36,6 @@ func TestSetLogLevel(t *testing.T) {
|
||||
c.Destroy()
|
||||
}
|
||||
|
||||
func BenchmarkDebugSerial(b *testing.B) {
|
||||
c := CreateClient("test")
|
||||
var x sync.WaitGroup
|
||||
x.Add(b.N)
|
||||
for i := 0; i < b.N; i++ {
|
||||
Debug(i)
|
||||
go func() {
|
||||
c.Get()
|
||||
x.Done()
|
||||
}()
|
||||
}
|
||||
x.Wait()
|
||||
c.Destroy()
|
||||
}
|
||||
|
||||
// Trace ensure logs come out in the right order
|
||||
func TestOrder(t *testing.T) {
|
||||
testString := "Testing trace: "
|
||||
|
||||
@@ -28,7 +28,7 @@ func (l Logger) Trace(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "TRACE",
|
||||
level: LTrace,
|
||||
Namespace: l.Namespace,
|
||||
@@ -42,7 +42,7 @@ func (l Logger) Tracef(format string, args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "TRACE",
|
||||
level: LTrace,
|
||||
Namespace: l.Namespace,
|
||||
@@ -56,7 +56,7 @@ func (l Logger) Traceln(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "TRACE",
|
||||
level: LTrace,
|
||||
Namespace: l.Namespace,
|
||||
@@ -70,7 +70,7 @@ func (l Logger) Debug(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "DEBUG",
|
||||
level: LDebug,
|
||||
Namespace: l.Namespace,
|
||||
@@ -84,7 +84,7 @@ func (l Logger) Debugf(format string, args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "DEBUG",
|
||||
level: LDebug,
|
||||
Namespace: l.Namespace,
|
||||
@@ -98,7 +98,7 @@ func (l Logger) Info(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "INFO",
|
||||
level: LInfo,
|
||||
Namespace: l.Namespace,
|
||||
@@ -112,7 +112,7 @@ func (l Logger) Infof(format string, args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "INFO",
|
||||
level: LInfo,
|
||||
Namespace: l.Namespace,
|
||||
@@ -126,7 +126,7 @@ func (l Logger) Infoln(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "INFO",
|
||||
level: LInfo,
|
||||
Namespace: l.Namespace,
|
||||
@@ -140,7 +140,7 @@ func (l Logger) Notice(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "NOTICE",
|
||||
level: LNotice,
|
||||
Namespace: l.Namespace,
|
||||
@@ -154,7 +154,7 @@ func (l Logger) Noticef(format string, args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "NOTICE",
|
||||
level: LNotice,
|
||||
Namespace: l.Namespace,
|
||||
@@ -168,7 +168,7 @@ func (l Logger) Noticeln(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "NOTICE",
|
||||
level: LNotice,
|
||||
Namespace: l.Namespace,
|
||||
@@ -182,7 +182,7 @@ func (l Logger) Warn(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "WARN",
|
||||
level: LWarn,
|
||||
Namespace: l.Namespace,
|
||||
@@ -196,7 +196,7 @@ func (l Logger) Warnf(format string, args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "WARN",
|
||||
level: LWarn,
|
||||
Namespace: l.Namespace,
|
||||
@@ -210,7 +210,7 @@ func (l Logger) Warnln(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "WARN",
|
||||
level: LWarn,
|
||||
Namespace: l.Namespace,
|
||||
@@ -224,7 +224,7 @@ func (l Logger) Error(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "ERROR",
|
||||
level: LError,
|
||||
Namespace: l.Namespace,
|
||||
@@ -238,7 +238,7 @@ func (l Logger) Errorf(format string, args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "ERROR",
|
||||
level: LError,
|
||||
Namespace: l.Namespace,
|
||||
@@ -252,7 +252,7 @@ func (l Logger) Errorln(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "ERROR",
|
||||
level: LError,
|
||||
Namespace: l.Namespace,
|
||||
@@ -266,13 +266,13 @@ func (l Logger) Panic(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "PANIC",
|
||||
level: LPanic,
|
||||
Namespace: l.Namespace,
|
||||
}
|
||||
createLog(e)
|
||||
if len(args) > 0 {
|
||||
if len(args) >= 0 {
|
||||
switch args[0].(type) {
|
||||
case error:
|
||||
panic(args[0])
|
||||
@@ -290,13 +290,13 @@ func (l Logger) Panicf(format string, args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "PANIC",
|
||||
level: LPanic,
|
||||
Namespace: l.Namespace,
|
||||
}
|
||||
createLog(e)
|
||||
if len(args) > 0 {
|
||||
if len(args) >= 0 {
|
||||
switch args[0].(type) {
|
||||
case error:
|
||||
panic(args[0])
|
||||
@@ -314,13 +314,13 @@ func (l Logger) Panicln(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "PANIC",
|
||||
level: LPanic,
|
||||
Namespace: l.Namespace,
|
||||
}
|
||||
createLog(e)
|
||||
if len(args) > 0 {
|
||||
if len(args) >= 0 {
|
||||
switch args[0].(type) {
|
||||
case error:
|
||||
panic(args[0])
|
||||
@@ -338,7 +338,7 @@ func (l Logger) Fatal(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "FATAL",
|
||||
level: LFatal,
|
||||
Namespace: l.Namespace,
|
||||
@@ -354,7 +354,7 @@ func (l Logger) Fatalf(format string, args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "FATAL",
|
||||
level: LFatal,
|
||||
Namespace: l.Namespace,
|
||||
@@ -370,7 +370,7 @@ func (l Logger) Fatalln(args ...any) {
|
||||
e := Entry{
|
||||
Timestamp: time.Now(),
|
||||
Output: output,
|
||||
File: fileInfo(2 + l.FileInfoDepth),
|
||||
File: fileInfo(l.FileInfoDepth),
|
||||
Level: "FATAL",
|
||||
level: LFatal,
|
||||
Namespace: l.Namespace,
|
||||
|
||||
10
main.go
10
main.go
@@ -17,21 +17,21 @@ func generateLogs() {
|
||||
apiLogger := logger.NewLogger("api")
|
||||
dbLogger := logger.NewLogger("database")
|
||||
authLogger := logger.NewLogger("auth")
|
||||
|
||||
|
||||
for {
|
||||
logger.Info("This is a default namespace log!")
|
||||
apiLogger.Info("API request received")
|
||||
apiLogger.Debug("Processing API call")
|
||||
|
||||
|
||||
dbLogger.Info("Database query executed")
|
||||
dbLogger.Warn("Slow query detected")
|
||||
|
||||
|
||||
authLogger.Info("User authentication successful")
|
||||
authLogger.Error("Failed login attempt detected")
|
||||
|
||||
|
||||
logger.Trace("This is a trace log in default namespace!")
|
||||
logger.Warn("This is a warning in default namespace!")
|
||||
|
||||
|
||||
time.Sleep(2 * time.Second)
|
||||
}
|
||||
}
|
||||
|
||||
165
slog/handler.go
165
slog/handler.go
@@ -1,165 +0,0 @@
|
||||
// Package slog provides a [log/slog.Handler] that routes structured log
|
||||
// records into the log-socket broadcasting system, giving every slog-based
|
||||
// caller free WebSocket streaming and the browser viewer UI.
|
||||
package slog
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"runtime"
|
||||
"strings"
|
||||
|
||||
"github.com/taigrr/log-socket/v2/log"
|
||||
)
|
||||
|
||||
// Handler implements [slog.Handler] by converting each [slog.Record] into a
|
||||
// log-socket [log.Entry] and feeding it through the normal broadcast path.
|
||||
//
|
||||
// Attributes accumulated via [Handler.WithAttrs] are prepended to the log
|
||||
// message as key=value pairs. Groups set via [Handler.WithGroup] prefix
|
||||
// attribute keys with "group.".
|
||||
type Handler struct {
|
||||
namespace string
|
||||
level slog.Level
|
||||
attrs []slog.Attr
|
||||
groups []string
|
||||
}
|
||||
|
||||
// ensure interface compliance at compile time.
|
||||
var _ slog.Handler = (*Handler)(nil)
|
||||
|
||||
// Option configures a [Handler].
|
||||
type Option func(*Handler)
|
||||
|
||||
// WithNamespace sets the log-socket namespace for entries produced by this
|
||||
// handler. If empty, [log.DefaultNamespace] is used.
|
||||
func WithNamespace(ns string) Option {
|
||||
return func(h *Handler) {
|
||||
h.namespace = ns
|
||||
}
|
||||
}
|
||||
|
||||
// WithLevel sets the minimum slog level the handler will accept.
|
||||
func WithLevel(l slog.Level) Option {
|
||||
return func(h *Handler) {
|
||||
h.level = l
|
||||
}
|
||||
}
|
||||
|
||||
// NewHandler returns a new [Handler] that writes to the log-socket broadcast
|
||||
// system. Options may be used to set the namespace and minimum level.
|
||||
func NewHandler(opts ...Option) *Handler {
|
||||
h := &Handler{
|
||||
namespace: log.DefaultNamespace,
|
||||
level: slog.LevelDebug,
|
||||
}
|
||||
for _, o := range opts {
|
||||
o(h)
|
||||
}
|
||||
return h
|
||||
}
|
||||
|
||||
// Enabled reports whether the handler is configured to process records at
|
||||
// the given level.
|
||||
func (h *Handler) Enabled(_ context.Context, level slog.Level) bool {
|
||||
return level >= h.level
|
||||
}
|
||||
|
||||
// Handle converts r into a log-socket Entry and broadcasts it.
|
||||
func (h *Handler) Handle(_ context.Context, r slog.Record) error {
|
||||
var b strings.Builder
|
||||
b.WriteString(r.Message)
|
||||
|
||||
// Append pre-collected attrs.
|
||||
for _, a := range h.attrs {
|
||||
writeAttr(&b, h.groups, a)
|
||||
}
|
||||
|
||||
// Append record-level attrs.
|
||||
r.Attrs(func(a slog.Attr) bool {
|
||||
writeAttr(&b, h.groups, a)
|
||||
return true
|
||||
})
|
||||
|
||||
file := "???"
|
||||
if r.PC != 0 {
|
||||
fs := runtime.CallersFrames([]uintptr{r.PC})
|
||||
f, _ := fs.Next()
|
||||
if f.File != "" {
|
||||
short := f.File
|
||||
if idx := strings.LastIndex(short, "/"); idx >= 0 {
|
||||
short = short[idx+1:]
|
||||
}
|
||||
file = fmt.Sprintf("%s:%d", short, f.Line)
|
||||
}
|
||||
}
|
||||
|
||||
e := log.Entry{
|
||||
Timestamp: r.Time,
|
||||
Output: b.String(),
|
||||
File: file,
|
||||
Level: slogLevelToString(r.Level),
|
||||
Namespace: h.namespace,
|
||||
}
|
||||
log.Broadcast(e)
|
||||
return nil
|
||||
}
|
||||
|
||||
// WithAttrs returns a new Handler with the given attributes appended.
|
||||
func (h *Handler) WithAttrs(attrs []slog.Attr) slog.Handler {
|
||||
h2 := h.clone()
|
||||
h2.attrs = append(h2.attrs, attrs...)
|
||||
return h2
|
||||
}
|
||||
|
||||
// WithGroup returns a new Handler where subsequent attributes are nested
|
||||
// under the given group name.
|
||||
func (h *Handler) WithGroup(name string) slog.Handler {
|
||||
if name == "" {
|
||||
return h
|
||||
}
|
||||
h2 := h.clone()
|
||||
h2.groups = append(h2.groups, name)
|
||||
return h2
|
||||
}
|
||||
|
||||
func (h *Handler) clone() *Handler {
|
||||
h2 := &Handler{
|
||||
namespace: h.namespace,
|
||||
level: h.level,
|
||||
attrs: make([]slog.Attr, len(h.attrs)),
|
||||
groups: make([]string, len(h.groups)),
|
||||
}
|
||||
copy(h2.attrs, h.attrs)
|
||||
copy(h2.groups, h.groups)
|
||||
return h2
|
||||
}
|
||||
|
||||
func writeAttr(b *strings.Builder, groups []string, a slog.Attr) {
|
||||
a.Value = a.Value.Resolve()
|
||||
if a.Equal(slog.Attr{}) {
|
||||
return
|
||||
}
|
||||
b.WriteByte(' ')
|
||||
for _, g := range groups {
|
||||
b.WriteString(g)
|
||||
b.WriteByte('.')
|
||||
}
|
||||
b.WriteString(a.Key)
|
||||
b.WriteByte('=')
|
||||
b.WriteString(a.Value.String())
|
||||
}
|
||||
|
||||
func slogLevelToString(l slog.Level) string {
|
||||
switch {
|
||||
case l >= slog.LevelError:
|
||||
return "ERROR"
|
||||
case l >= slog.LevelWarn:
|
||||
return "WARN"
|
||||
case l >= slog.LevelInfo:
|
||||
return "INFO"
|
||||
default:
|
||||
return "DEBUG"
|
||||
}
|
||||
}
|
||||
@@ -1,118 +0,0 @@
|
||||
package slog
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log/slog"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/taigrr/log-socket/v2/log"
|
||||
)
|
||||
|
||||
// getWithTimeout reads from a log client with a timeout to avoid hanging tests.
|
||||
func getWithTimeout(c *log.Client, timeout time.Duration) (log.Entry, bool) {
|
||||
ch := make(chan log.Entry, 1)
|
||||
go func() { ch <- c.Get() }()
|
||||
select {
|
||||
case e := <-ch:
|
||||
return e, true
|
||||
case <-time.After(timeout):
|
||||
return log.Entry{}, false
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandler_Enabled(t *testing.T) {
|
||||
h := NewHandler(WithLevel(slog.LevelWarn))
|
||||
if h.Enabled(context.Background(), slog.LevelInfo) {
|
||||
t.Error("expected Info to be disabled when min level is Warn")
|
||||
}
|
||||
if !h.Enabled(context.Background(), slog.LevelWarn) {
|
||||
t.Error("expected Warn to be enabled")
|
||||
}
|
||||
if !h.Enabled(context.Background(), slog.LevelError) {
|
||||
t.Error("expected Error to be enabled")
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandler_Handle(t *testing.T) {
|
||||
c := log.CreateClient()
|
||||
defer c.Destroy()
|
||||
c.SetLogLevel(log.LTrace)
|
||||
|
||||
h := NewHandler(WithNamespace("test-ns"))
|
||||
logger := slog.New(h)
|
||||
|
||||
logger.Info("hello world", "key", "value")
|
||||
|
||||
e, ok := getWithTimeout(c, time.Second)
|
||||
if !ok {
|
||||
t.Fatal("timed out waiting for log entry")
|
||||
}
|
||||
if e.Namespace != "test-ns" {
|
||||
t.Errorf("namespace = %q, want %q", e.Namespace, "test-ns")
|
||||
}
|
||||
if e.Level != "INFO" {
|
||||
t.Errorf("level = %q, want INFO", e.Level)
|
||||
}
|
||||
if e.Output == "" {
|
||||
t.Error("output should not be empty")
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandler_WithAttrs(t *testing.T) {
|
||||
c := log.CreateClient()
|
||||
defer c.Destroy()
|
||||
c.SetLogLevel(log.LTrace)
|
||||
|
||||
h := NewHandler()
|
||||
h2 := h.WithAttrs([]slog.Attr{slog.String("service", "api")})
|
||||
logger := slog.New(h2)
|
||||
|
||||
logger.Info("request")
|
||||
|
||||
e, ok := getWithTimeout(c, time.Second)
|
||||
if !ok {
|
||||
t.Fatal("timed out")
|
||||
}
|
||||
if e.Output != "request service=api" {
|
||||
t.Errorf("output = %q, want %q", e.Output, "request service=api")
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandler_WithGroup(t *testing.T) {
|
||||
c := log.CreateClient()
|
||||
defer c.Destroy()
|
||||
c.SetLogLevel(log.LTrace)
|
||||
|
||||
h := NewHandler()
|
||||
h2 := h.WithGroup("http").WithAttrs([]slog.Attr{slog.Int("status", 200)})
|
||||
logger := slog.New(h2)
|
||||
|
||||
logger.Info("done")
|
||||
|
||||
e, ok := getWithTimeout(c, time.Second)
|
||||
if !ok {
|
||||
t.Fatal("timed out")
|
||||
}
|
||||
if e.Output != "done http.status=200" {
|
||||
t.Errorf("output = %q, want %q", e.Output, "done http.status=200")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSlogLevelMapping(t *testing.T) {
|
||||
tests := []struct {
|
||||
level slog.Level
|
||||
want string
|
||||
}{
|
||||
{slog.LevelDebug, "DEBUG"},
|
||||
{slog.LevelInfo, "INFO"},
|
||||
{slog.LevelWarn, "WARN"},
|
||||
{slog.LevelError, "ERROR"},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
got := slogLevelToString(tt.level)
|
||||
if got != tt.want {
|
||||
t.Errorf("slogLevelToString(%v) = %q, want %q", tt.level, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -23,7 +23,7 @@ func LogSocketHandler(w http.ResponseWriter, r *http.Request) {
|
||||
if namespacesParam != "" {
|
||||
namespaces = strings.Split(namespacesParam, ",")
|
||||
}
|
||||
|
||||
|
||||
c, err := upgrader.Upgrade(w, r, nil)
|
||||
if err != nil {
|
||||
logger.Error("upgrade:", err)
|
||||
|
||||
Reference in New Issue
Block a user