Skip to content

Commit b383cc8

Browse files
committed
chore: add defaults and host description
1 parent 545665b commit b383cc8

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

test/readme.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,15 @@ Refer to the `run-spec-benchmark-tests-node-server` task for Node.js version, Mo
251251

252252
The server is run in standalone mode and the server versions are aliased by this script: https://github.com/mongodb-labs/drivers-evergreen-tools/blob/5048cca80e9ca62642409de2d401058bbd7057fa/.evergreen/mongodl.py#L58 check the latest version to see what alias the driver is running against.
253253

254-
The host used is described here: https://spruce.mongodb.com/distro/rhel90-dbx-perf-large/settings/general (Auth required to view)
254+
The host used is described in detail here: https://spruce.mongodb.com/distro/rhel90-dbx-perf-large/settings/general (Auth required to view)
255+
256+
Here is a rough list of the key configurations:
257+
258+
- cpu: Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz
259+
- cores: 16
260+
- arch: x64
261+
- os: RHEL 9.0 linux (5.14.0-70.75.1.el9_0.x86_64)
262+
- ram: 64 GB
255263

256264
It is best to try reproductions against as similar a deployment as possible to isolate regressions.
257265

@@ -261,9 +269,9 @@ The benchmarks can be directed to test different settings and driver versions.
261269

262270
The following are environment variables and how the benchmark runner uses them:
263271

264-
- `MONGODB_DRIVER_PATH` - if set MUST be set to the directory a driver version is in, usually another clone of the driver checked out to a different revision.
265-
- `MONGODB_CLIENT_OPTIONS` - if set MUST be a JSON string that will be parsed and passed as the second argument to the MongoClient constructor.
266-
- `MONGODB_URI` - if set MUST be a valid MongoDB connection string and it will be used as the host the benchmarks will run against.
272+
- `MONGODB_DRIVER_PATH` - (default: current working driver) if set MUST be set to the directory a driver version is in, usually another clone of the driver checked out to a different revision.
273+
- `MONGODB_CLIENT_OPTIONS` - (default: empty object) if set MUST be a JSON string that will be parsed and passed as the second argument to the MongoClient constructor.
274+
- `MONGODB_URI` - (default: `mongodb://127.0.0.1:27017`) if set MUST be a valid MongoDB connection string and it will be used as the host the benchmarks will run against.
267275

268276
It may be desirable to test how changes to `BSON` impact the driver's performance.
269277

0 commit comments

Comments
 (0)