NodeJS setup for MongoDB instrumentation
MongoDB instrument for NodeJS
Make sure you have
activated the mongodb
instrument
in your CodSpeed GitHub workflow.
In-depth guides
To see complete guides of the different integrations, check out the pages below:
Benchmarking a MongoDB based NestJS API with vitest
Setup and run MongoDB performance tests in a Node.js API using vitest, leveraging Docker.
Benchmarking a MongoDB based NestJS API with tinybench
Setup and run MongoDB performance tests in a Node.js API using tinybench, leveraging Docker.
Dynamically providing the connection string
Each integration exports a setupInstruments
function that can be used to
dynamically setup the instruments. This function takes the actual connection
string as an argument and returns the patched connection string that should be
used to connect to the database.
You can use this function to set up the instruments in your application:
The example above uses the
testcontainers
library to
start a MongoDB container and get the connection string. Then, the
setupInstruments
function is used to patch the connection string and set it as
the MONGO_URL
environment variable. Finally, the bench
is run as usual.
The setupInstruments
function should be called only once during the whole
benchmark run, and before any connection to the database is established.
Otherwise, the CodSpeed MongoDB instrument will not be able to collect the
metrics.