Monitoring & Metrics

Observability is crucial for production search engines. pg-smart-search provides built-in health checks and real-time metrics.

Health Checks

Verify the status of your dependencies before accepting traffic.

const status = await engine.health();

console.log(status);
// Output: { db: ok, cache: ok, vectorProvider: degraded }

The health() method executes lightweight queries against your PostgreSQL database, Redis cache (if configured), and tests connectivity to your Vector provider.

Real-Time Metrics

Access performance metrics directly from the engine instance:

console.log(engine.metrics);
// Output: { cacheHitRate: 0.92, dbLatency: 12, providerErrors: 0 }

Available Metrics

• cacheHitRate: A float between 0 and 1 representing the percentage of queries served from cache.
• dbLatency: Average database query execution time in milliseconds over the last 100 queries.
• providerErrors: Total number of errors encountered with external providers (e.g., OpenAI/Gemini API errors).

You can expose these metrics to Prometheus, Datadog, or your preferred monitoring tool by periodically reading engine.metrics.