From 5deba3a00372ded66273231defbbace921dd8c36 Mon Sep 17 00:00:00 2001 From: Jian Guan <61915096+tdq45gj@users.noreply.github.com> Date: Mon, 23 Sep 2024 10:15:14 -0400 Subject: [PATCH 1/2] Update README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 464988ac..1ee869c5 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,34 @@ The verifier will now check to completion to make sure that there are no inconsi `{"progress":{"phase":"idle","error":null,"verificationStatus":{"totalTasks":1,"addedTasks":0,"processingTasks":0,"failedTasks":1,"completedTasks":0,"metadataMismatchTasks":0,"recheckTasks":0}}}` +# CLI Options + +| Flag | Description | +|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --configFile value | path to an optional YAML config file | +| --srcURI URI | source Host URI for migration verification (default: "mongodb://localhost:27017") | +| --dstURI URI | destination Host URI for migration verification (default: "mongodb://localhost:27018") | +| --metaURI URI | host URI for storing migration verification metadata (default: "mongodb://localhost:27019") | +| --serverPort port | port for the control web server (default: 27020) | +| --logPath path | logging file path (default: "stdout") | +| --numWorkers number | number of worker threads to use for verification (default: 10) | +| --generationPauseDelay milliseconds | milliseconds to wait between generations of rechecking, allowing for more time to turn off writes (default: 1000) | +| --workerSleepDelay milliseconds | milliseconds workers sleep while waiting for work (default: 1000) | +| --srcNamespace namespaces | source namespaces to check | +| --dstNamespace namespaces | destination namespaces to check | +| --metaDBName name | name of the database in which to store verification metadata (default: "migration_verification_metadata") | +| --ignoreFieldOrder | Whether or not field order is ignored in documents | +| --verifyAll | If set, verify all user namespaces | +| --clean | If set, drop all previous verification metadata before starting | +| --readPreference value | Read preference for reading data from clusters. May be 'primary', 'secondary', 'primaryPreferred', 'secondaryPreferred', or 'nearest' (default: "primary") | +| --partitionSizeMB Megabytes | Megabytes to use for a partition. Change only for debugging. 0 means use partitioner default. (default: 0) | +| --debug | Turn on debug logging | +| --checkOnly | Do not run the webserver or recheck, just run the check (for debugging) | +| --failureDisplaySize value | Number of failures to display. Will display all failures if the number doesn’t exceed this limit by 25% (default: 20) | +| --ignoreReadConcern | Use connection-default read concerns rather than setting majority read concern. This option may degrade consistency, so only enable it if majority read concern (the default) doesn’t work. | +| --help, -h | show help | + + # Benchmarking Results Ran on m6id.metal + M40 with 3 replica sets From 748a4e1ecb64931a343c12ad7927ce59092d260c Mon Sep 17 00:00:00 2001 From: Jian Guan <61915096+tdq45gj@users.noreply.github.com> Date: Mon, 23 Sep 2024 10:20:38 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 1ee869c5..b53c4a8e 100644 --- a/README.md +++ b/README.md @@ -108,30 +108,30 @@ The verifier will now check to completion to make sure that there are no inconsi # CLI Options -| Flag | Description | -|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --configFile value | path to an optional YAML config file | -| --srcURI URI | source Host URI for migration verification (default: "mongodb://localhost:27017") | -| --dstURI URI | destination Host URI for migration verification (default: "mongodb://localhost:27018") | -| --metaURI URI | host URI for storing migration verification metadata (default: "mongodb://localhost:27019") | -| --serverPort port | port for the control web server (default: 27020) | -| --logPath path | logging file path (default: "stdout") | -| --numWorkers number | number of worker threads to use for verification (default: 10) | -| --generationPauseDelay milliseconds | milliseconds to wait between generations of rechecking, allowing for more time to turn off writes (default: 1000) | -| --workerSleepDelay milliseconds | milliseconds workers sleep while waiting for work (default: 1000) | -| --srcNamespace namespaces | source namespaces to check | -| --dstNamespace namespaces | destination namespaces to check | -| --metaDBName name | name of the database in which to store verification metadata (default: "migration_verification_metadata") | -| --ignoreFieldOrder | Whether or not field order is ignored in documents | -| --verifyAll | If set, verify all user namespaces | -| --clean | If set, drop all previous verification metadata before starting | -| --readPreference value | Read preference for reading data from clusters. May be 'primary', 'secondary', 'primaryPreferred', 'secondaryPreferred', or 'nearest' (default: "primary") | -| --partitionSizeMB Megabytes | Megabytes to use for a partition. Change only for debugging. 0 means use partitioner default. (default: 0) | -| --debug | Turn on debug logging | -| --checkOnly | Do not run the webserver or recheck, just run the check (for debugging) | -| --failureDisplaySize value | Number of failures to display. Will display all failures if the number doesn’t exceed this limit by 25% (default: 20) | -| --ignoreReadConcern | Use connection-default read concerns rather than setting majority read concern. This option may degrade consistency, so only enable it if majority read concern (the default) doesn’t work. | -| --help, -h | show help | +| Flag | Description | +|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--configFile ` | path to an optional YAML config file | +| `--srcURI ` | source Host URI for migration verification (default: "mongodb://localhost:27017") | +| `--dstURI ` | destination Host URI for migration verification (default: "mongodb://localhost:27018") | +| `--metaURI ` | host URI for storing migration verification metadata (default: "mongodb://localhost:27019") | +| `--serverPort ` | port for the control web server (default: 27020) | +| `--logPath ` | logging file path (default: "stdout") | +| `--numWorkers ` | number of worker threads to use for verification (default: 10) | +| `--generationPauseDelay ` | milliseconds to wait between generations of rechecking, allowing for more time to turn off writes (default: 1000) | +| `--workerSleepDelay ` | milliseconds workers sleep while waiting for work (default: 1000) | +| `--srcNamespace ` | source namespaces to check | +| `--dstNamespace ` | destination namespaces to check | +| `--metaDBName ` | name of the database in which to store verification metadata (default: "migration_verification_metadata") | +| `--ignoreFieldOrder` | Whether or not field order is ignored in documents | +| `--verifyAll` | If set, verify all user namespaces | +| `--clean` | If set, drop all previous verification metadata before starting | +| `--readPreference ` | Read preference for reading data from clusters. May be 'primary', 'secondary', 'primaryPreferred', 'secondaryPreferred', or 'nearest' (default: "primary") | +| `--partitionSizeMB ` | Megabytes to use for a partition. Change only for debugging. 0 means use partitioner default. (default: 0) | +| `--debug` | Turn on debug logging | +| `--checkOnly` | Do not run the webserver or recheck, just run the check (for debugging) | +| `--failureDisplaySize ` | Number of failures to display. Will display all failures if the number doesn’t exceed this limit by 25% (default: 20) | +| `--ignoreReadConcern` | Use connection-default read concerns rather than setting majority read concern. This option may degrade consistency, so only enable it if majority read concern (the default) doesn’t work. | +| `--help`, `-h` | show help | # Benchmarking Results