構成

設定

構成ファイルを使用して、次の mongosync 設定を構成できます。

コマンドラインから を設定するには 、「mongosync コマンドライン オプション 」を参照してください。

acceptDisclaimer

タイプ : ブール値

埋め込み検証子に弁別子を受け入れます。

この設定なしで mongosync プロセスが開始されると、ユーザーは各ディスククレームを受け入れるように求められます。

この設定により、すでにディスク クレームを読み取って承認したユーザーは、ディスク クレームを受け入れ、mongosync プロセスを開始できます。

コマンドラインからacceptDisclaimer設定を行うには、 --acceptDisclaimerオプションを参照してください。

バージョン1.9の新機能。

cluster0

型: string

Sets the connection URI for the first cluster. The first cluster can serve as either the source or the destination in the sync process. Designate the source and destination clusters in the call to the start API endpoint.

mongosync の接続の詳細については、「 接続」を参照してください。

コマンドラインからcluster0設定を行うには、 --cluster0オプションを参照してください。

cluster1

型: string

Sets the connection URI for the second cluster. The second cluster can serve as either the source or the destination in the sync process. Designate the source and destination clusters in the call to the start API endpoint.

mongosync の接続の詳細については、「 接続」を参照してください。

コマンドラインからcluster1設定を行うには、 --cluster1オプションを参照してください。

createIndexesBatchSize

バージョン1.19.0の新機能。

タイプ: 整数

最小: 1

最大: 64

宛先クラスターでのインデックス構築のバッチするサイズを明示的に設定する。デフォルトでは 、mongosync は Atlas 宛先クラスターでこの値をプログラム的に最適化します。

警告

インデックスごとに 100MB-1 GBのメモリを割り当てていることを確認してください。さらに、同時インデックス構築によって使用される合計メモリが宛先クラスターのRAMの 20% 未満であることを確認してください。インデックス構築に宛先RAMの 20% 以上を割り当てると、 ファイルシステムキャッシュに干渉する可能性があり、宛先クラスターへの書込みのバッファリングに使用できるメモリが減ります。

詳細については、インデックス構築の最適化 を参照してください。

コマンドラインからcreateIndexesBatchSize設定を行うには、 --createIndexesBatchSizeオプションを参照してください。

disableMetricsLogging

タイプ: ブール値

バージョン1.16.0の新機能。

Mongosync バイナリを実行するときに、メトリクスのログ記録を無効にします。

警告

効果的なトラブルシューティングとサポートを容易にするために、 メトリクスのログ を有効にしておくことを 強く推奨 します。

詳細については、Mongosync メトリクス を参照してください。

コマンドラインからdisableMetricsLogging設定を行うには、 --disableMetricsLoggingオプションを参照してください。

詳しくは、「 ユーザー データの収集」を参照してください。

disableTelemetry

タイプ: ブール値

バージョン1.4.0の新機能。

mongosync の テレメトリー データの収集を無効にします。

デフォルトでは、mongosync　MongoDB 製品を改善するために匿名の集約された使用状況データを収集します。mongosync を実行すると、このテレメトリー データのコレクションを無効にできます。

コマンドラインからdisableTelemetry設定を行うには、 --disableTelemetryオプションを参照してください。

詳しくは、「 ユーザー データの収集」を参照してください。

disableVerification

タイプ: ブール値

埋め込み検証子 を無効にします。無効にすると、mongosync は移行を検証しません。 別の検証方法については、「 データ転送の検証 」を参照してください。

このオプションは、検証付きで mongosync を実行中中に OOM 強制終了が発生し、 より多くのリソースを割り当てたり、 再起動の検証を許容したりできないカスタマーの回避策となります。 これにより、検証を無効にして移行を完了できます。 その後の再起動や元に戻すときは、検証は無効のままになります。

このオプションは、mongosync が最初に起動される場合は使用しないでください。 代わりに、 /startリクエストパラメータ verification.enabled: falseを使用して検証を無効にします。検証はデフォルトで有効になっているためです。

コマンドラインからの検証を無効にするには、--disableVerification オプションを参照してください。

バージョン1.10の新機能。

enableCappedCollectionHandling

タイプ: ブール値

mongosync では、移行中に新しい上限付きコレクションの作成を有効にするには、このフラグを渡す必要があります。

移行中に新しい上限付きコレクションの作成を有効にするには、 true に設定します。デフォルトは false です。

コマンドラインからenableCappedCollectionHandling設定を行うには、 --enableCappedCollectionHandlingオプションを参照してください。

バージョン1.20の新機能。

hotDocIDs

型: string

ホットドキュメント、またはソースクラスター上で非常に頻繁に更新されるドキュメントの識別子を設定します。次に、mongosync は移行コミット ステージ中にこれらのドキュメントをコピーします。

mongosyncを実行中中にホットドキュメントが原因でレプリケーションラグが発生する移行には、この設定を使用します。

識別子は次の形式で指定します。

{
   “db”: <string>, // the name of the database
   "collection" : <string>, // name of the collection
   "ids"    : [ {“_id”:<Object>”}, ...],
}

idsフィールド内のオブジェクトは、有効な標準モード拡張JSON文字列である必要があります。

この設定を複数回使用して、複数のコレクションからホットドキュメント識別子を提供できます。次は、コレクション coll1 と coll2 から 2 つのホットドキュメント識別子を提供する例です。

mongosync \
--hotDocIDs '{"db":"db1","collection":"coll1","ids":[{"_id":{"$oid":"doc1"}},{"_id":{"$oid":"6aa23c249cef3cd958e43785"}}]}' \
--hotDocIDs '{"db":"db2","collection":"coll2","ids":[{"_id":{"$oid":"70023c249cef3cd958e43269"}},{"_id":{"$oid":"7aa23c249cef3cd958e43785"}}]}' \
... other CLI arguments ...

一度開始すると、ホットドキュメント識別子を除くことはできません。誤って設定した場合は、正しい識別子で mongosync を再起動します。

注意

mongosync 逆同期でホット ドキュメントを保持しません。逆同期中にホット ドキュメントによりレプリケーションラグが発生した場合は、mongosync プロセスを再起動し、逆方向のホット ドキュメント識別子を指定します。移行をゼロから再開始しないでください。

コマンドラインから hotDocIDs を設定するには、--hotDocIDs オプションを参照してください。

id

型: string

mongosync インスタンスの識別子を設定します。

シャーディングされたクラスターでmongosyncの複数のインスタンスを実行中の場合は、この設定を使用して、シャードを個別に同期します。

The identifier value for this setting must correspond to the shard ID of the shard it syncs. To find the shard ID, use the listShards command.

コマンドラインからid設定を行うには、 --idオプションを参照してください。

loadLevel

タイプ: 整数

デフォルト: 3

ソースクラスターと宛先クラスター間でデータを同期するためのクラスターワークロードレベルを設定します。

• 4これは最上位の設定で、クラスターのワークロードが最大化され、データが最速で同期されます。

• 1これは最下位の設定で、クラスタのワークロードが最小限に抑えられ、データの同期は最も遅くなります。

コマンドラインからloadLevel設定を行うには、 --loadLevelオプションを参照してください。

警告

loadLevel をデフォルトの 3 よりも高く設定すると、宛先クラスターのパフォーマンスに悪影響を及ぼす可能性があります。

ソースクラスターに読み取りボトルネックが存在する場合、または宛先クラスターに書込みボトルネックが存在する場合、loadLevel を減らすとパフォーマンスが向上する可能性があります。

バージョン1.4の新機能。

logPath

型: string

ログディレクトリへのパスを設定します。Mongosync は、このディレクトリ内のファイルにログを書込みます。

詳しくは、「ログ記録」を参照してください。

コマンドラインからlogPath設定を行うには、 --logPathオプションを参照してください。

metricsLoggingFilepath

型: string

バージョン1.16.0の新機能。

メトリクスログディレクトリへのパスを設定します。Mongosync は、このディレクトリ内のファイルにメトリクス ログを書込みます。

詳細については、Mongosync メトリクス を参照してください。

コマンドラインからmetricsLoggingFilepath設定を行うには、 --metricsLoggingFilepathオプションを参照してください。

port

タイプ: 整数

デフォルト: 27182

Mongosync HTTP APIのHTTPサーバーが使用するポートを設定します。

コマンドラインからport設定を行うには、 --portオプションを参照してください。

verbosity

型: string

デフォルト: DEBUG

ログメッセージの冗長レベルを設定します。Mongosync では、指定されたレベルのすべてのメッセージと、それより低いレベルのすべてのメッセージがログに記録されます。

verbosity設定では次の値がサポートされています。

• TRACE

• DEBUG

• INFO

• WARN

• ERROR

• FATAL

• PANIC

コマンドラインからverbosity設定を行うには、 --verbosityオプションを参照してください。