Docs Home → Develop Applications → MongoDB Drivers → Node.js

Connection Pool Monitoring

On this page

Overview

Event Subscription Example
Event Descriptions
Example Event Documents
connectionPoolCreated
connectionPoolReady
connectionPoolClosed
connectionCreated
connectionReady
connectionClosed
connectionCheckOutStarted
connectionCheckOutFailed
connectionCheckedOut
connectionCheckedIn
connectionPoolCleared

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the MongoDB Node.js driver.

Overview

This guide shows you how to monitor the driver's connection pool. A connection pool is a set of open TCP connections your driver maintains with a MongoDB instance. Connection pools help reduce the number of network handshakes your application needs to perform and can help your application run faster.

Read this guide if you need to record connection pool events in your application or want to explore the information provided in these events.

Event Subscription Example

You can access one or more connection pool events using the driver by subscribing to them in your application. The following example demonstrates connecting to a replica set and subscribing to one of the connection pool monitoring events created by the MongoDB deployment:

const { MongoClient } = require("mongodb");
// Replace the following with your MongoDB deployment's connection
// string.
const uri =
  "mongodb+srv://<clusterUrl>/?replicaSet=rs&writeConcern=majority";
const client = new MongoClient(uri);
// Replace <event name> with the name of the event you are subscribing to.
const eventName = "<event name>";
client.on(eventName, (event) =>
  console.log("\nreceived event:\n", event)
);
async function run() {
  try {
    // Establish and verify connection
    await client.db("admin").command({ ping: 1 });
    console.log("\nConnected successfully!\n");
  } finally {
    // Ensures that the client will close when you finish/error
    await client.close();
  }
}
run().catch(console.dir);

Event Descriptions

You can subscribe to any of the following connection pool monitoring events:

Event Name	Description
`connectionPoolCreated`	Created when a connection pool is created.
`connectionPoolReady`	Created when a connection pool is ready.
`connectionPoolClosed`	Created when a connection pool is closed, prior to server instance destruction.
`connectionCreated`	Created when a connection is created, but not necessarily when it is used for an operation.
`connectionReady`	Created after a connection has successfully completed a handshake and is ready to be used for operations.
`connectionClosed`	Created when a connection is closed.
`connectionCheckOutStarted`	Created when an operation attempts to acquire a connection for execution.
`connectionCheckOutFailed`	Created when an operation fails to acquire a connection for execution.
`connectionCheckedOut`	Created when an operation successfully acquires a connection for execution.
`connectionCheckedIn`	Created when a connection is checked back into the pool after an operation is executed.
`connectionPoolCleared`	Created when a connection pool is cleared.

Example Event Documents

The following sections show sample output for each type of connection pool monitoring event.

connectionPoolCreated

ConnectionPoolCreatedEvent {
  time: 2023-02-13T15:54:06.944Z,
  address: '...',
  options: {...}
}

connectionPoolReady

ConnectionPoolReadyEvent {
  time: 2023-02-13T15:56:38.440Z,
  address: '...'
}

connectionPoolClosed

ConnectionPoolClosedEvent {
  time: 2023-02-13T15:56:38.440Z,
  address: '...'
}

connectionCreated

ConnectionCreatedEvent {
  time: 2023-02-13T15:56:38.291Z,
  address: '...',
  connectionId: 1
}

connectionReady

ConnectionReadyEvent {
  time: 2023-02-13T15:56:38.291Z,
  address: '...',
  connectionId: 1
}

connectionClosed

ConnectionClosedEvent {
  time: 2023-02-13T15:56:38.439Z,
  address: '...',
  connectionId: 1,
  reason: 'poolClosed',
  serviceId: undefined
}

connectionCheckOutStarted

ConnectionCheckOutStartedEvent {
  time: 2023-02-13T15:56:38.291Z,
  address: '...',
}

connectionCheckOutFailed

ConnectionCheckOutFailedEvent {
  time: 2023-02-13T15:56:38.291Z,
  address: '...',
  reason: ...
}

connectionCheckedOut

ConnectionCheckedOutEvent {
  time: 2023-02-13T15:54:07.188Z,
  address: '...',
  connectionId: 1
}

connectionCheckedIn

ConnectionCheckedInEvent {
  time: 2023-02-13T15:54:07.189Z,
  address: '...',
  connectionId: 1
}

connectionPoolCleared

ConnectionPoolClearedEvent {
  time: 2023-02-13T15:56:38.439Z,
  address: '...',
  serviceId: undefined,
  interruptInUseConnections: true,
}

← Command Monitoring GridFS →