Docs Menu

mongosync

mongosync バイナリーは、Cluster-to-Cluster Sync で使用されるプライマリ プロセスです。mongosync は、ソースクラスターからデスティネーションクラスターにデータを移行し、同期を完了するまでクラスターを継続的に同期させます。データの継続的な同期に加えて、mongosync はクラスター間の 1 回限りのデータ移行も実行できます。

mongosyncプロセスの概要については、「 mongosyncについて 」を参照してください。

mongosync を使い始めるには、「クイック スタート ガイド」を参照してください。

よくある質問(FAQ)ページでは、mongosync に関してユーザーから寄せられた質問を取り上げています。

以下のmongosyncコマンドのレイアウトは表示用に変更されています。 mongosyncを使用してcluster0cluster1に接続するには、次のコマンドを 1 行で入力します。

mongosync \
--cluster0 "<cluster0_connection_string>" \
--cluster1 "<cluster1_connection_string>"

接続文字列の形式方法の詳細については、「 mongosyncの接続 」を参照してください。

コマンドラインを使用して、次の mongosync オプションを設定できます。

構成ファイルから mongosync を設定するには、構成ファイルをご覧ください。

--acceptDisclaimer

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

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

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

構成ファイルから --acceptDisclaimer オプションを設定するには、 acceptDisclaimer 設定を参照してください。

バージョン 1.9 の新機能

--cluster0 <uri>

最初のクラスターの接続 URIを設定します。最初のクラスターは、同期プロセスのソースまたは宛先として機能できます。start API エンドポイントの呼び出しでソースクラスターと宛先クラスターを指定します。

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

構成ファイルから --cluster0 オプションを設定するには、 cluster0 設定を参照してください。

警告

一部のシステムでは、--cluster0 または --cluster1 オプションを使用して接続文字列にパスワードを指定すると、他のユーザーによって呼び出される可能性のある ps などのシステム ステータス プログラムにパスワードが表示される場合があります。

代わりに--configオプションを使用して、パスワードを含む構成ファイルを指定することを検討してください。

--cluster1 <uri>

2 番目のクラスターの接続 URI を設定します。2 番目のクラスターは、同期プロセスのソースまたは宛先のいずれかとして機能します。start API エンドポイントの呼び出しでソースクラスターと宛先クラスターを指定します。

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

構成ファイルから --cluster1 オプションを設定するには、 cluster1 設定を参照してください。

警告

一部のシステムでは、--cluster0 または --cluster1 オプションを使用して接続文字列にパスワードを指定すると、他のユーザーによって呼び出される可能性のある ps などのシステム ステータス プログラムにパスワードが表示される場合があります。

代わりに--configオプションを使用して、パスワードを含む構成ファイルを指定することを検討してください。

--config <filename>

構成ファイルへのパスを設定します。

移行中に構成ファイルのパスを設定するには、「同期中の mongosync の再構成」を参照してください。

詳しくは、構成ファイル を参照してください。

--disableTelemetry

バージョン 1.4.0 の新機能

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

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

構成ファイルから --disableTelemetry オプションを設定するには、 disableTelemetry 設定を参照してください。

移行中にテレメトリー データの収集を無効にするには、同期中の mongosync の再構成を参照してください。

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

--disableVerification

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

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

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

構成ファイルから検証を無効にするには、disableVerification の設定をご覧ください。

バージョン 1.10 の新機能

--help, -h

使用情報を stdout に出力します。

--id <id>

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

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

このオプションの識別子の値は、同期するシャードのシャード ID に対応していなければなりません。シャード ID を見つけるには、listShards コマンドを使用します。

構成ファイルから --id オプションを設定するには、 id 設定を参照してください。

--loadLevel <level>

タイプ: 整数

default: 3

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

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

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

構成ファイルから --loadLevel オプションを設定するには、 loadLevel 設定を参照してください。

移行中に負荷レベルを変更するには、「同期中の mongosync の再構成」をご覧ください。

警告

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

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

バージョン 1.4 で追加

--logPath <directory>

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

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

構成ファイルから --logPath オプションを設定するには、 logPath 設定を参照してください。

移行中にログディレクトリのパスを変更するには、同期中の mongosync の再構成を参照してください。

注意

--logPathオプションを使用してmongosyncを起動すると、ログファイルをローテーションするためにUSR1シグナルをmongosyncプロセスに送信できます。

kill -s USR1 $mongosync_pid

$mongosync_pidは、 mongosyncプロセス ID です。

--port

default: 27182

Cluster-to-Cluster Sync HTTP API の HTTP サーバーが使用するポートを設定します。

構成ファイルから --port オプションを設定するには、 port 設定を参照してください。

移行中にポートを変更するには、同期中の mongosync の再構成を参照してください。

--verbosity <level>

default: DEBUG

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

--verbosity オプションでは、次の値がサポートされています。

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • FATAL

  • PANIC

構成ファイルから --verbosity オプションを設定するには、 verbosity 設定を参照してください。

移行中に冗長度レベルを変更するには、同期中のmongosyncの再構成を参照してください。

--version, -v

mongosyncのバージョン情報を stdout に出力します。

詳しくは、「 mongosyncの動作 」を参照してください。