refactor: emit structured json logs
This commit is contained in:
@@ -5,7 +5,6 @@ import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"log"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
@@ -156,17 +155,22 @@ func logJikanCache(cacheKey string, source string, startedAt time.Time, err erro
|
||||
return
|
||||
}
|
||||
|
||||
errorValue := ""
|
||||
level := observability.LogLevelInfo
|
||||
if err != nil {
|
||||
errorValue = err.Error()
|
||||
level = observability.LogLevelError
|
||||
}
|
||||
|
||||
log.Printf(
|
||||
"jikan_cache key=%s source=%s duration_ms=%.2f error=%s",
|
||||
strconv.Quote(cacheKey),
|
||||
source,
|
||||
float64(duration.Microseconds())/1000,
|
||||
strconv.Quote(errorValue),
|
||||
observability.LogJSON(
|
||||
level,
|
||||
"jikan_cache",
|
||||
"jikan",
|
||||
"",
|
||||
map[string]any{
|
||||
"cache_key": cacheKey,
|
||||
"source": source,
|
||||
"duration_ms": float64(duration.Microseconds()) / 1000,
|
||||
},
|
||||
err,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -176,18 +180,24 @@ func logJikanUpstream(urlStr string, statusCode int, attempts int, startedAt tim
|
||||
return
|
||||
}
|
||||
|
||||
errorValue := ""
|
||||
if err != nil {
|
||||
errorValue = err.Error()
|
||||
level := observability.LogLevelInfo
|
||||
if err != nil || statusCode >= http.StatusBadRequest {
|
||||
level = observability.LogLevelError
|
||||
}
|
||||
|
||||
log.Printf(
|
||||
"jikan_upstream url=%s status=%d attempts=%d duration_ms=%.2f error=%s",
|
||||
strconv.Quote(urlStr),
|
||||
statusCode,
|
||||
attempts,
|
||||
float64(duration.Microseconds())/1000,
|
||||
strconv.Quote(errorValue),
|
||||
observability.LogJSON(
|
||||
level,
|
||||
"jikan_upstream",
|
||||
"jikan",
|
||||
"",
|
||||
map[string]any{
|
||||
"url": urlStr,
|
||||
"endpoint": metricsEndpoint(urlStr),
|
||||
"status": statusCode,
|
||||
"attempts": attempts,
|
||||
"duration_ms": float64(duration.Microseconds()) / 1000,
|
||||
},
|
||||
err,
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
51
internal/observability/log.go
Normal file
51
internal/observability/log.go
Normal file
@@ -0,0 +1,51 @@
|
||||
package observability
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"log"
|
||||
"time"
|
||||
)
|
||||
|
||||
type LogLevel string
|
||||
|
||||
const (
|
||||
LogLevelInfo LogLevel = "info"
|
||||
LogLevelWarn LogLevel = "warn"
|
||||
LogLevelError LogLevel = "error"
|
||||
)
|
||||
|
||||
type LogEvent struct {
|
||||
TS string `json:"ts"`
|
||||
Level LogLevel `json:"level"`
|
||||
Event string `json:"event"`
|
||||
Message string `json:"message,omitempty"`
|
||||
Fields map[string]any `json:"fields,omitempty"`
|
||||
Error string `json:"error,omitempty"`
|
||||
Component string `json:"component,omitempty"`
|
||||
}
|
||||
|
||||
func LogJSON(level LogLevel, event string, component string, message string, fields map[string]any, err error) {
|
||||
errorValue := ""
|
||||
if err != nil {
|
||||
errorValue = err.Error()
|
||||
}
|
||||
|
||||
entry := LogEvent{
|
||||
TS: time.Now().UTC().Format(time.RFC3339Nano),
|
||||
Level: level,
|
||||
Event: event,
|
||||
Message: message,
|
||||
Fields: fields,
|
||||
Error: errorValue,
|
||||
Component: component,
|
||||
}
|
||||
|
||||
// Best-effort. If encoding fails, fall back to a minimal line.
|
||||
bytes, marshalErr := json.Marshal(entry)
|
||||
if marshalErr != nil {
|
||||
log.Printf("level=%s event=%s component=%s error=%q", level, event, component, marshalErr.Error())
|
||||
return
|
||||
}
|
||||
|
||||
log.Print(string(bytes))
|
||||
}
|
||||
@@ -1,9 +1,7 @@
|
||||
package server
|
||||
|
||||
import (
|
||||
"log"
|
||||
"mal/internal/observability"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
@@ -25,17 +23,23 @@ func RequestLogger(metrics *observability.Metrics) gin.HandlerFunc {
|
||||
duration := time.Since(start)
|
||||
metrics.ObserveHTTPRequest(c.Request.Method, route, c.Writer.Status(), duration)
|
||||
|
||||
log.Printf(
|
||||
"http_request method=%s route=%s path=%s query=%s status=%d duration_ms=%.2f bytes=%d client_ip=%s errors=%s",
|
||||
c.Request.Method,
|
||||
strconv.Quote(route),
|
||||
strconv.Quote(path),
|
||||
strconv.Quote(query),
|
||||
c.Writer.Status(),
|
||||
float64(duration.Microseconds())/1000,
|
||||
c.Writer.Size(),
|
||||
strconv.Quote(c.ClientIP()),
|
||||
strconv.Quote(c.Errors.ByType(gin.ErrorTypePrivate).String()),
|
||||
observability.LogJSON(
|
||||
observability.LogLevelInfo,
|
||||
"http_request",
|
||||
"http",
|
||||
"",
|
||||
map[string]any{
|
||||
"method": c.Request.Method,
|
||||
"route": route,
|
||||
"path": path,
|
||||
"query": query,
|
||||
"status": c.Writer.Status(),
|
||||
"duration_ms": float64(duration.Microseconds()) / 1000,
|
||||
"bytes": c.Writer.Size(),
|
||||
"client_ip": c.ClientIP(),
|
||||
"errors": c.Errors.ByType(gin.ErrorTypePrivate).String(),
|
||||
},
|
||||
nil,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -58,10 +58,13 @@ func TestRequestLoggerUsesMatchedRoute(t *testing.T) {
|
||||
}
|
||||
|
||||
logLine := string(output)
|
||||
if !strings.Contains(logLine, `route="/anime/:id"`) {
|
||||
if !strings.Contains(logLine, `"event":"http_request"`) {
|
||||
t.Fatalf("log line missing event: %s", logLine)
|
||||
}
|
||||
if !strings.Contains(logLine, `"route":"/anime/:id"`) {
|
||||
t.Fatalf("log line missing route: %s", logLine)
|
||||
}
|
||||
if !strings.Contains(logLine, `status=200`) {
|
||||
if !strings.Contains(logLine, `"status":200`) {
|
||||
t.Fatalf("log line missing status: %s", logLine)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user