1
0
mirror of https://github.com/taigrr/log-socket synced 2026-03-20 16:02:28 -07:00

4 Commits

Author SHA1 Message Date
703f80c5f6 docs: add example programs for common usage patterns
Adds four focused examples in examples/ directory:
- basic: drop-in logger with web UI
- namespaces: namespace-based logging by component
- client: programmatic log client with filtering
- log-levels: all log levels and filtering

Fixes #7
2026-02-20 08:02:17 +00:00
47bfb5ed98 fix: stderr namespace filter, fileInfo depth, panic guard, race safety
- fix(stderr): CreateClient() with no args so stderr sees all namespaces,
  not just 'default'. Previously namespaced logs were invisible on stderr.
- fix(logger): fileInfo depth offset to 2+FileInfoDepth so Logger methods
  report the actual caller, not the log package itself. Default depth (0)
  now correctly shows caller file:line.
- fix(panic): guard args[0] access with len(args) > 0 instead of >= 0.
  Panic/Panicf/Panicln would index out of range when called with no args.
- fix(createLog): nil/initialized check before channel send to prevent
  race with concurrent Destroy calls.
- chore: bump go.mod to 1.25.6
2026-02-17 08:31:21 +00:00
6a709d3963 feat(log): add colored terminal output without external packages (#16)
Adds ANSI color-coded log levels for terminal output:
- TRACE: Gray
- DEBUG: Cyan
- INFO: Green
- NOTICE: Blue
- WARN: Yellow
- ERROR/PANIC/FATAL: Red (bold for PANIC/FATAL)

Colors are auto-detected based on terminal capability and can be
controlled via SetColorEnabled()/ColorEnabled().

Fixes #9
2026-02-17 03:27:53 -05:00
0a78d1ce90 test: add comprehensive benchmark suite (#18)
Adds benchmarks for all log levels (Trace, Debug, Info, Warn, Error),
formatted logging, multiple client fan-out, parallel writes, namespace
filtering, and component-level benchmarks (fileInfo, entry creation).

Uses isolated namespaces to avoid interference with the stderr client.

Fixes #6
2026-02-17 03:25:12 -05:00
14 changed files with 591 additions and 432 deletions

View File

@@ -15,6 +15,7 @@ A real-time log viewer with WebSocket support and namespace filtering, written i
- **Namespace filtering**: Subscribe to specific namespaces via WebSocket - **Namespace filtering**: Subscribe to specific namespaces via WebSocket
- **Frontend namespace selector**: Filter logs by namespace in the web UI - **Frontend namespace selector**: Filter logs by namespace in the web UI
- **Namespace API**: GET `/api/namespaces` to list all active namespaces - **Namespace API**: GET `/api/namespaces` to list all active namespaces
- **Colored terminal output**: Log levels are color-coded in terminal (no external packages)
## Features ## Features
@@ -188,6 +189,40 @@ ws://localhost:8080/ws?namespaces=api,database # Multiple namespaces
- **Color Coding**: Different log levels are color-coded - **Color Coding**: Different log levels are color-coded
- **Reconnect**: Reconnect WebSocket with new namespace filter - **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 ## Migration from v1
### Import Path ### Import Path

36
examples/basic/main.go Normal file
View File

@@ -0,0 +1,36 @@
// 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))
}

63
examples/client/main.go Normal file
View File

@@ -0,0 +1,63 @@
// 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()
}

View File

@@ -0,0 +1,48 @@
// 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")
}

View File

@@ -0,0 +1,73 @@
// 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
View File

@@ -1,5 +1,5 @@
module github.com/taigrr/log-socket/v2 module github.com/taigrr/log-socket/v2
go 1.25.4 go 1.25.6
require github.com/gorilla/websocket v1.5.3 require github.com/gorilla/websocket v1.5.3

171
log/bench_test.go Normal file
View File

@@ -0,0 +1,171 @@
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)
}
}

View File

@@ -1,389 +0,0 @@
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 Normal file
View File

@@ -0,0 +1,99 @@
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))
}

View File

@@ -22,7 +22,8 @@ var (
func init() { func init() {
namespaces = make(map[string]bool) namespaces = make(map[string]bool)
stderrClient = CreateClient(DefaultNamespace) initColorEnabled()
stderrClient = CreateClient()
stderrClient.SetLogLevel(LTrace) stderrClient.SetLogLevel(LTrace)
stderrFinished = make(chan bool, 1) stderrFinished = make(chan bool, 1)
go stderrClient.logStdErr() go stderrClient.logStdErr()
@@ -31,7 +32,10 @@ func init() {
func (c *Client) logStdErr() { func (c *Client) logStdErr() {
for e := range c.writer { for e := range c.writer {
if e.level >= c.LogLevel && c.matchesNamespace(e.Namespace) { if e.level >= c.LogLevel && c.matchesNamespace(e.Namespace) {
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) 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)
} }
} }
stderrFinished <- true stderrFinished <- true
@@ -70,19 +74,19 @@ func Flush() {
} }
func (c *Client) Destroy() error { func (c *Client) Destroy() error {
var otherClients []*Client
if !c.initialized { if !c.initialized {
panic(errors.New("cannot delete uninitialized client, did you use CreateClient?")) panic(errors.New("cannot delete uninitialized client, did you use CreateClient?"))
} }
sliceTex.Lock() sliceTex.Lock()
c.writer = nil
c.initialized = false c.initialized = false
var otherClients []*Client
for _, x := range clients { for _, x := range clients {
if x.initialized { if x != c && x.initialized {
otherClients = append(otherClients, x) otherClients = append(otherClients, x)
} }
} }
clients = otherClients clients = otherClients
c.writer = nil
sliceTex.Unlock() sliceTex.Unlock()
return nil return nil
} }
@@ -99,10 +103,13 @@ func createLog(e Entry) {
namespacesMux.Lock() namespacesMux.Lock()
namespaces[e.Namespace] = true namespaces[e.Namespace] = true
namespacesMux.Unlock() namespacesMux.Unlock()
sliceTex.Lock() sliceTex.Lock()
for _, c := range clients { for _, c := range clients {
func(c *Client, e Entry) { func(c *Client, e Entry) {
if c.writer == nil || !c.initialized {
return
}
// Filter by namespace if client has filters specified // Filter by namespace if client has filters specified
if !c.matchesNamespace(e.Namespace) { if !c.matchesNamespace(e.Namespace) {
return return
@@ -126,7 +133,7 @@ func createLog(e Entry) {
func GetNamespaces() []string { func GetNamespaces() []string {
namespacesMux.RLock() namespacesMux.RLock()
defer namespacesMux.RUnlock() defer namespacesMux.RUnlock()
result := make([]string, 0, len(namespaces)) result := make([]string, 0, len(namespaces))
for ns := range namespaces { for ns := range namespaces {
result = append(result, ns) result = append(result, ns)
@@ -417,7 +424,7 @@ func Panic(args ...any) {
Namespace: DefaultNamespace, Namespace: DefaultNamespace,
} }
createLog(e) createLog(e)
if len(args) >= 0 { if len(args) > 0 {
switch args[0].(type) { switch args[0].(type) {
case error: case error:
panic(args[0]) panic(args[0])
@@ -441,7 +448,7 @@ func Panicf(format string, args ...any) {
Namespace: DefaultNamespace, Namespace: DefaultNamespace,
} }
createLog(e) createLog(e)
if len(args) >= 0 { if len(args) > 0 {
switch args[0].(type) { switch args[0].(type) {
case error: case error:
panic(args[0]) panic(args[0])
@@ -464,7 +471,7 @@ func Panicln(args ...any) {
Namespace: DefaultNamespace, Namespace: DefaultNamespace,
} }
createLog(e) createLog(e)
if len(args) >= 0 { if len(args) > 0 {
switch args[0].(type) { switch args[0].(type) {
case error: case error:
panic(args[0]) panic(args[0])

View File

@@ -2,6 +2,7 @@ package log
import ( import (
"strconv" "strconv"
"sync"
"testing" "testing"
) )
@@ -36,6 +37,21 @@ func TestSetLogLevel(t *testing.T) {
c.Destroy() 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 // Trace ensure logs come out in the right order
func TestOrder(t *testing.T) { func TestOrder(t *testing.T) {
testString := "Testing trace: " testString := "Testing trace: "

View File

@@ -28,7 +28,7 @@ func (l Logger) Trace(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "TRACE", Level: "TRACE",
level: LTrace, level: LTrace,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -42,7 +42,7 @@ func (l Logger) Tracef(format string, args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "TRACE", Level: "TRACE",
level: LTrace, level: LTrace,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -56,7 +56,7 @@ func (l Logger) Traceln(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "TRACE", Level: "TRACE",
level: LTrace, level: LTrace,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -70,7 +70,7 @@ func (l Logger) Debug(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "DEBUG", Level: "DEBUG",
level: LDebug, level: LDebug,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -84,7 +84,7 @@ func (l Logger) Debugf(format string, args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "DEBUG", Level: "DEBUG",
level: LDebug, level: LDebug,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -98,7 +98,7 @@ func (l Logger) Info(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "INFO", Level: "INFO",
level: LInfo, level: LInfo,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -112,7 +112,7 @@ func (l Logger) Infof(format string, args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "INFO", Level: "INFO",
level: LInfo, level: LInfo,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -126,7 +126,7 @@ func (l Logger) Infoln(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "INFO", Level: "INFO",
level: LInfo, level: LInfo,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -140,7 +140,7 @@ func (l Logger) Notice(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "NOTICE", Level: "NOTICE",
level: LNotice, level: LNotice,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -154,7 +154,7 @@ func (l Logger) Noticef(format string, args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "NOTICE", Level: "NOTICE",
level: LNotice, level: LNotice,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -168,7 +168,7 @@ func (l Logger) Noticeln(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "NOTICE", Level: "NOTICE",
level: LNotice, level: LNotice,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -182,7 +182,7 @@ func (l Logger) Warn(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "WARN", Level: "WARN",
level: LWarn, level: LWarn,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -196,7 +196,7 @@ func (l Logger) Warnf(format string, args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "WARN", Level: "WARN",
level: LWarn, level: LWarn,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -210,7 +210,7 @@ func (l Logger) Warnln(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "WARN", Level: "WARN",
level: LWarn, level: LWarn,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -224,7 +224,7 @@ func (l Logger) Error(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "ERROR", Level: "ERROR",
level: LError, level: LError,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -238,7 +238,7 @@ func (l Logger) Errorf(format string, args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "ERROR", Level: "ERROR",
level: LError, level: LError,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -252,7 +252,7 @@ func (l Logger) Errorln(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "ERROR", Level: "ERROR",
level: LError, level: LError,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -266,13 +266,13 @@ func (l Logger) Panic(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "PANIC", Level: "PANIC",
level: LPanic, level: LPanic,
Namespace: l.Namespace, Namespace: l.Namespace,
} }
createLog(e) createLog(e)
if len(args) >= 0 { if len(args) > 0 {
switch args[0].(type) { switch args[0].(type) {
case error: case error:
panic(args[0]) panic(args[0])
@@ -290,13 +290,13 @@ func (l Logger) Panicf(format string, args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "PANIC", Level: "PANIC",
level: LPanic, level: LPanic,
Namespace: l.Namespace, Namespace: l.Namespace,
} }
createLog(e) createLog(e)
if len(args) >= 0 { if len(args) > 0 {
switch args[0].(type) { switch args[0].(type) {
case error: case error:
panic(args[0]) panic(args[0])
@@ -314,13 +314,13 @@ func (l Logger) Panicln(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "PANIC", Level: "PANIC",
level: LPanic, level: LPanic,
Namespace: l.Namespace, Namespace: l.Namespace,
} }
createLog(e) createLog(e)
if len(args) >= 0 { if len(args) > 0 {
switch args[0].(type) { switch args[0].(type) {
case error: case error:
panic(args[0]) panic(args[0])
@@ -338,7 +338,7 @@ func (l Logger) Fatal(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "FATAL", Level: "FATAL",
level: LFatal, level: LFatal,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -354,7 +354,7 @@ func (l Logger) Fatalf(format string, args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "FATAL", Level: "FATAL",
level: LFatal, level: LFatal,
Namespace: l.Namespace, Namespace: l.Namespace,
@@ -370,7 +370,7 @@ func (l Logger) Fatalln(args ...any) {
e := Entry{ e := Entry{
Timestamp: time.Now(), Timestamp: time.Now(),
Output: output, Output: output,
File: fileInfo(l.FileInfoDepth), File: fileInfo(2 + l.FileInfoDepth),
Level: "FATAL", Level: "FATAL",
level: LFatal, level: LFatal,
Namespace: l.Namespace, Namespace: l.Namespace,

10
main.go
View File

@@ -17,21 +17,21 @@ func generateLogs() {
apiLogger := logger.NewLogger("api") apiLogger := logger.NewLogger("api")
dbLogger := logger.NewLogger("database") dbLogger := logger.NewLogger("database")
authLogger := logger.NewLogger("auth") authLogger := logger.NewLogger("auth")
for { for {
logger.Info("This is a default namespace log!") logger.Info("This is a default namespace log!")
apiLogger.Info("API request received") apiLogger.Info("API request received")
apiLogger.Debug("Processing API call") apiLogger.Debug("Processing API call")
dbLogger.Info("Database query executed") dbLogger.Info("Database query executed")
dbLogger.Warn("Slow query detected") dbLogger.Warn("Slow query detected")
authLogger.Info("User authentication successful") authLogger.Info("User authentication successful")
authLogger.Error("Failed login attempt detected") authLogger.Error("Failed login attempt detected")
logger.Trace("This is a trace log in default namespace!") logger.Trace("This is a trace log in default namespace!")
logger.Warn("This is a warning in default namespace!") logger.Warn("This is a warning in default namespace!")
time.Sleep(2 * time.Second) time.Sleep(2 * time.Second)
} }
} }

View File

@@ -23,7 +23,7 @@ func LogSocketHandler(w http.ResponseWriter, r *http.Request) {
if namespacesParam != "" { if namespacesParam != "" {
namespaces = strings.Split(namespacesParam, ",") namespaces = strings.Split(namespacesParam, ",")
} }
c, err := upgrader.Upgrade(w, r, nil) c, err := upgrader.Upgrade(w, r, nil)
if err != nil { if err != nil {
logger.Error("upgrade:", err) logger.Error("upgrade:", err)