[web] collect mongo stats on native client (#32909)

* [metrics] mongo: fail when command monitoring is not available

* [metrics] mongo: add optional client label to pool metrics

* [web] collect mongo stats on native client

* [metrics] mongo: record namespace of find commands

* [metrics] mongo: add counter for all the commands with collection label

* [web] add missing mock

GitOrigin-RevId: 9f378d8aa8d7167f56cf512681d63ef115c6dd98

libraries/metrics/mongodb.js

@@ -1,67 +1,106 @@
-const { Gauge, Summary } = require('prom-client')
+const { Gauge, Summary, Counter } = require('prom-client')
 
-function monitor(mongoClient) {
+/** @type {poolSize: Gauge<string>, availableConnections: Gauge<string>, waitQueueSize: Gauge<string>, maxPoolSize: Gauge<string>, mongoCommandStarted: Counter<string>, mongoCommandTimer: Summary<string>} */
-  const labelNames = ['mongo_server']
+let metrics
+const collectPoolMetrics = []
+
+/**
+ * @param clientLabel
+ */
+function initMetricsOnce(clientLabel) {
+  if (metrics) return
+  const poolLabelNames = ['mongo_server']
+  if (clientLabel) poolLabelNames.push('client')
   const poolSize = new Gauge({
     name: 'mongo_connection_pool_size',
     help: 'number of connections in the connection pool',
-    labelNames,
+    labelNames: poolLabelNames,
     // Use this one metric's collect() to set all metrics' values.
-    collect,
+    collect() {
+      // Reset all gauges in case they contain values for servers that
+      // disappeared
+      metrics.poolSize.reset()
+      metrics.availableConnections.reset()
+      metrics.waitQueueSize.reset()
+      metrics.maxPoolSize.reset()
+      collectPoolMetrics.forEach(fn => fn())
+    },
   })
   const availableConnections = new Gauge({
     name: 'mongo_connection_pool_available',
     help: 'number of connections that are not busy',
-    labelNames,
+    labelNames: poolLabelNames,
   })
   const waitQueueSize = new Gauge({
     name: 'mongo_connection_pool_waiting',
     help: 'number of operations waiting for an available connection',
-    labelNames,
+    labelNames: poolLabelNames,
   })
   const maxPoolSize = new Gauge({
     name: 'mongo_connection_pool_max',
     help: 'max size for the connection pool',
-    labelNames,
+    labelNames: poolLabelNames,
   })
 
+  const mongoCommandStarted = new Counter({
+    name: 'mongo_command_started',
+    help: 'mongo command started',
+    labelNames: ['method', 'collection'],
+  })
   const mongoCommandTimer = new Summary({
     name: 'mongo_command_time',
     help: 'time taken to complete a mongo command',
     percentiles: [],
-    labelNames: ['status', 'method'],
+    labelNames: ['status', 'method', 'ns'],
   })
 
-  if (mongoClient.on) {
+  metrics = {
-    mongoClient.on('commandSucceeded', event => {
+    poolSize,
-      mongoCommandTimer.observe(
+    availableConnections,
-        {
+    waitQueueSize,
-          status: 'success',
+    maxPoolSize,
-          method: event.commandName === 'find' ? 'read' : 'write',
+    mongoCommandStarted,
-        },
+    mongoCommandTimer,
-        event.duration
-      )
-    })
-
-    mongoClient.on('commandFailed', event => {
-      mongoCommandTimer.observe(
-        {
-          status: 'failed',
-          method: event.commandName === 'find' ? 'read' : 'write',
-        },
-        event.duration
-      )
-    })
   }
+  return metrics
+}
+
+function monitor(mongoClient, clientLabel) {
+  initMetricsOnce(clientLabel)
+
+  mongoClient.on('commandStarted', event => {
+    const { commandName, command } = event
+    const collection = command?.[commandName]
+    if (typeof collection !== 'string') return // Lifecycle commands
+    if (commandName === 'create') return // Mongoose init
+    metrics.mongoCommandStarted.inc({
+      method: commandName === 'find' ? 'read' : 'write',
+      collection,
+    })
+  })
+
+  mongoClient.on('commandSucceeded', event => {
+    metrics.mongoCommandTimer.observe(
+      {
+        status: 'success',
+        method: event.commandName === 'find' ? 'read' : 'write',
+        ns: event.reply?.cursor?.ns, // best effort, set on 'find'
+      },
+      event.duration
+    )
+  })
+
+  mongoClient.on('commandFailed', event => {
+    metrics.mongoCommandTimer.observe(
+      {
+        status: 'failed',
+        method: event.commandName === 'find' ? 'read' : 'write',
+      },
+      event.duration
+    )
+  })
 
   function collect() {
-    // Reset all gauges in case they contain values for servers that
-    // disappeared
-    poolSize.reset()
-    availableConnections.reset()
-    waitQueueSize.reset()
-    maxPoolSize.reset()
-
     const servers = mongoClient.topology?.s?.servers
     if (servers != null) {
       for (const [address, server] of servers) {
@@ -72,13 +111,21 @@ function monitor(mongoClient) {
         }
 
         const labels = { mongo_server: address }
-        poolSize.set(labels, pool.totalConnectionCount)
+        if (clientLabel) labels.client = clientLabel
-        availableConnections.set(labels, pool.availableConnectionCount)
+        metrics.poolSize.set(labels, pool.totalConnectionCount)
-        waitQueueSize.set(labels, pool.waitQueueSize)
+        metrics.availableConnections.set(labels, pool.availableConnectionCount)
-        maxPoolSize.set(labels, pool.options.maxPoolSize)
+        metrics.waitQueueSize.set(labels, pool.waitQueueSize)
+        metrics.maxPoolSize.set(labels, pool.options.maxPoolSize)
       }
     }
   }
+  collectPoolMetrics.push(collect)
 }
 
-module.exports = { monitor }
+module.exports = {
+  monitor,
+  reset() {
+    metrics = undefined
+    collectPoolMetrics.length = 0
+  },
+}

libraries/metrics/test/unit/js/mongodb.js

@@ -14,11 +14,15 @@ describe('mongodb', function () {
     }
     this.servers = new Map([['server1', { s: { pool: this.pool } }]])
 
-    this.mongoClient = { topology: { s: { servers: this.servers } } }
+    this.mongoClient = {
+      on() {},
+      topology: { s: { servers: this.servers } },
+    }
+    Metrics.mongodb.reset()
   })
 
   it('handles an unconnected client', async function () {
-    const mongoClient = {}
+    const mongoClient = { on() {} }
     Metrics.mongodb.monitor(mongoClient)
     const metrics = await getMetrics()
     expect(metrics).to.deep.equal({})
@@ -35,6 +39,17 @@ describe('mongodb', function () {
     })
   })
 
+  it('collects Mongo metrics with client', async function () {
+    Metrics.mongodb.monitor(this.mongoClient, 'native')
+    const metrics = await getMetrics()
+    expect(metrics).to.deep.equal({
+      'mongo_connection_pool_max:server1:native': 10,
+      'mongo_connection_pool_size:server1:native': 8,
+      'mongo_connection_pool_available:server1:native': 2,
+      'mongo_connection_pool_waiting:server1:native': 4,
+    })
+  })
+
   it('handles topology changes', async function () {
     Metrics.mongodb.monitor(this.mongoClient)
     let metrics = await getMetrics()
@@ -81,7 +96,10 @@ async function getMetrics() {
   const result = {}
   for (const metric of metrics) {
     for (const value of metric.values) {
-      const key = `${metric.name}:${value.labels.mongo_server}`
+      let key = `${metric.name}:${value.labels.mongo_server}`
+      if (value.labels.client) {
+        key = `${key}:${value.labels.client}`
+      }
       result[key] = value.value
     }
   }

services/web/app/src/infrastructure/Mongoose.mjs

@@ -11,17 +11,7 @@ const connectionPromise = mongoose.connect(
   Settings.mongo.url,
   Settings.mongo.options
 )
-
+Metrics.mongodb.monitor(mongoose.connection.client, 'mongoose')
-connectionPromise
-  .then(mongooseInstance => {
-    Metrics.mongodb.monitor(mongooseInstance.connection.client)
-  })
-  .catch(error => {
-    logger.error(
-      { error },
-      'Failed to connect to MongoDB - cannot set up monitoring'
-    )
-  })
 
 addConnectionDrainer('mongoose', async () => {
   await connectionPromise

services/web/app/src/infrastructure/mongodb.mjs

@@ -4,6 +4,7 @@ import Settings from '@overleaf/settings'
 import MongoUtils from '@overleaf/mongo-utils'
 import Mongoose from './Mongoose.mjs'
 import { addConnectionDrainer } from './GracefulShutdown.mjs'
+import Metrics from '@overleaf/metrics'
 
 // Ensure Mongoose is using the same mongodb instance as the mongodb module,
 // otherwise we will get multiple versions of the ObjectId class. Mongoose
@@ -27,6 +28,7 @@ const mongoClient = new mongodb.MongoClient(
   Settings.mongo.url,
   Settings.mongo.options
 )
+Metrics.mongodb.monitor(mongoClient, 'native')
 
 addConnectionDrainer('mongodb', async () => {
   await mongoClient.close()

services/web/test/unit/bootstrap.mjs

@@ -59,6 +59,7 @@ vi.mock('@overleaf/metrics', () => {
         }
       },
       prom: { Counter: sinon.stub(), Histogram: sinon.stub() },
+      mongodb: { monitor: sinon.stub() },
     },
   }
 })