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.
73 lines
2.2 KiB
Go
73 lines
2.2 KiB
Go
package observability
|
|
|
|
import (
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/promauto"
|
|
"github.com/prometheus/client_golang/prometheus/promhttp"
|
|
)
|
|
|
|
// Metrics contains the Prometheus metrics for the application.
|
|
type Metrics struct {
|
|
RequestsTotal *prometheus.CounterVec
|
|
RequestDuration *prometheus.HistogramVec
|
|
DBQueriesTotal *prometheus.CounterVec
|
|
DBQueryDuration *prometheus.HistogramVec
|
|
}
|
|
|
|
// NewMetrics creates and registers the Prometheus metrics.
|
|
func NewMetrics(reg prometheus.Registerer) *Metrics {
|
|
return &Metrics{
|
|
RequestsTotal: promauto.With(reg).NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "http_requests_total",
|
|
Help: "Total number of HTTP requests.",
|
|
},
|
|
[]string{"method", "path", "status"},
|
|
),
|
|
RequestDuration: promauto.With(reg).NewHistogramVec(
|
|
prometheus.HistogramOpts{
|
|
Name: "http_request_duration_seconds",
|
|
Help: "Duration of HTTP requests.",
|
|
Buckets: prometheus.DefBuckets,
|
|
},
|
|
[]string{"method", "path"},
|
|
),
|
|
DBQueriesTotal: promauto.With(reg).NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "db_queries_total",
|
|
Help: "Total number of database queries.",
|
|
},
|
|
[]string{"operation", "status"},
|
|
),
|
|
DBQueryDuration: promauto.With(reg).NewHistogramVec(
|
|
prometheus.HistogramOpts{
|
|
Name: "db_query_duration_seconds",
|
|
Help: "Duration of database queries.",
|
|
Buckets: prometheus.DefBuckets,
|
|
},
|
|
[]string{"operation", "status"},
|
|
),
|
|
}
|
|
}
|
|
|
|
// PrometheusMiddleware returns an HTTP middleware that records Prometheus metrics.
|
|
func (m *Metrics) PrometheusMiddleware(next http.Handler) http.Handler {
|
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
start := time.Now()
|
|
rw := &responseWriter{ResponseWriter: w}
|
|
next.ServeHTTP(rw, r)
|
|
|
|
duration := time.Since(start).Seconds()
|
|
m.RequestDuration.WithLabelValues(r.Method, r.URL.Path).Observe(duration)
|
|
m.RequestsTotal.WithLabelValues(r.Method, r.URL.Path, http.StatusText(rw.statusCode)).Inc()
|
|
})
|
|
}
|
|
|
|
// PrometheusHandler returns an HTTP handler for serving Prometheus metrics.
|
|
func PrometheusHandler(reg prometheus.Gatherer) http.Handler {
|
|
return promhttp.HandlerFor(reg, promhttp.HandlerOpts{})
|
|
}
|