mirror of
https://github.com/SamyRai/tercul-backend.git
synced 2025-12-27 05:11:34 +00:00
781b313bf1
This commit addresses all the high-priority tasks outlined in the TASKS.md file, significantly improving the application's observability, completing key features, and refactoring critical parts of the codebase. ### Observability - **Centralized Logging:** Implemented a new structured, context-aware logging system using `zerolog`. A new logging middleware injects request-specific information (request ID, user ID, trace ID) into the logger, and all application logging has been refactored to use this new system. - **Prometheus Metrics:** Added Prometheus metrics for database query performance by creating a GORM plugin that automatically records query latency and totals. - **OpenTelemetry Tracing:** Fully instrumented all application services in `internal/app` and data repositories in `internal/data/sql` with OpenTelemetry tracing, providing deep visibility into application performance. ### Features - **Analytics:** Implemented like, comment, and bookmark counting. The respective command handlers now call the analytics service to increment counters when these actions are performed. - **Enrichment Tool:** Built a new, extensible `enrich` command-line tool to fetch data from external sources. The initial implementation enriches author data using the Open Library API. ### Refactoring & Fixes - **Decoupled Testing:** Refactored the testing utilities in `internal/testutil` to be database-agnostic, promoting the use of mock-based unit tests and improving test speed and reliability. - **Build Fixes:** Resolved numerous build errors, including a critical import cycle between the logging, observability, and authentication packages. - **Search Service:** Fixed the search service integration by implementing the `GetWorkContent` method in the localization service, allowing the search indexer to correctly fetch and index work content.
60 lines
1.7 KiB
Go
60 lines
1.7 KiB
Go
package observability
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"time"
|
|
|
|
"github.com/rs/zerolog"
|
|
"go.opentelemetry.io/otel/trace"
|
|
)
|
|
|
|
// Logger is a wrapper around zerolog.Logger to provide a consistent logging interface.
|
|
type Logger struct {
|
|
*zerolog.Logger
|
|
}
|
|
|
|
// NewLogger creates a new Logger instance.
|
|
// It writes to a human-friendly console in "development" environment,
|
|
// and writes JSON to stdout otherwise.
|
|
func NewLogger(serviceName, environment string) *Logger {
|
|
var logger zerolog.Logger
|
|
if environment == "development" {
|
|
logger = zerolog.New(zerolog.ConsoleWriter{Out: os.Stderr, TimeFormat: time.RFC3339}).With().
|
|
Timestamp().
|
|
Str("service", serviceName).
|
|
Logger()
|
|
} else {
|
|
zerolog.TimeFieldFormat = time.RFC3339
|
|
logger = zerolog.New(os.Stdout).With().
|
|
Timestamp().
|
|
Str("service", serviceName).
|
|
Logger()
|
|
}
|
|
|
|
return &Logger{&logger}
|
|
}
|
|
|
|
// Ctx returns a new logger with context-specific fields, such as trace and span IDs.
|
|
func (l *Logger) Ctx(ctx context.Context) *Logger {
|
|
log := l.Logger // log is a *zerolog.Logger
|
|
span := trace.SpanFromContext(ctx)
|
|
if span.SpanContext().IsValid() {
|
|
// .Logger() returns a value, not a pointer.
|
|
// We create a new logger value...
|
|
newLogger := log.With().
|
|
Str("trace_id", span.SpanContext().TraceID().String()).
|
|
Str("span_id", span.SpanContext().SpanID().String()).
|
|
Logger()
|
|
// ...and then use its address.
|
|
log = &newLogger
|
|
}
|
|
// `log` is now the correct *zerolog.Logger, so we wrap it.
|
|
return &Logger{log}
|
|
}
|
|
|
|
// With adds a key-value pair to the logger's context.
|
|
func (l *Logger) With(key string, value interface{}) *Logger {
|
|
newLogger := l.Logger.With().Interface(key, value).Logger()
|
|
return &Logger{&newLogger}
|
|
} |