Docs Menu

構成

コマンドラインオプションまたは構成ファイル を使用して、スタートアップ時に mongosync インスタンスを構成できます。構成ファイルでは、 mongosyncコマンドラインオプションと同等の設定の値を指定します。

移行中に、「mongosync 同期中に を再構成する 」の手順に従って、特定のmongosync 設定を再構成できます。

ほとんどのmongosyncコマンドライン オプションを YAML ファイルに書込み (write) できます。 構成ファイルでは、YAML 形式を使用して各設定の値を指定します。

以下に例を挙げます。

cluster0: "mongodb://192.0.2.10:27017"
cluster1: "mongodb://192.0.2.20:27017"
logPath: "/var/log/mongosync"
verbosity: "WARN"

構成ファイルを使用するには、 --configオプションを使用してmongosyncを起動し、ファイルへのパスを設定します。

mongosync --config <configPath>

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

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

注意

startコマンドは、 reversibilityuser write blockingなどの機能の追加オプションを提供します。 詳細については、 start API ドキュメントを参照してください。

acceptDisclaimer

タイプ : ブール値

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

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

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

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

バージョン 1.9 の新機能

cluster0

: string

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

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

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

cluster1

: string

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

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

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

disableTelemetry

タイプ: ブール値

バージョン 1.4.0 の新機能

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

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

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

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

disableVerification

タイプ: ブール値

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

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

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

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

バージョン 1.10 の新機能

id

: string

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

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

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

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

loadLevel

タイプ: 整数

default: 3

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

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

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

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

警告

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

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

バージョン 1.4 で追加

logPath

: string

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

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

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

port

タイプ: 整数

default: 27182

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

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

verbosity

: string

default: DEBUG

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

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

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • FATAL

  • PANIC

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

重要

移行中に調整できるのは、次の設定のみです。 mongosyncの再起動間でその他の設定を変更しないでください。

が同期している間に、次の手順を実行して、--disableTelemetry 、 、 mongosync--config--loadLevel--logPath--port--verbosity オプションを再構成できます。

1

実行中の各pause プロセスでmongosync を実行します。

最後のステップに示すように、一時停止状態から後でmongosyncプロセスを再開できます。

Tip

再構成後、すぐにデータ同期操作を再開したくない場合は、mongosync プロセスを一時停止することを検討してください。 これは、複数の mongosync プロセスからの操作を調整する場合に便利です。

2

オペレーティング システムを使用して、実行中の各 mongosync プロセスを停止します。 具体的な手順については、オペレーティング システムのドキュメントを参照してください。

3

--configを最初に初期化するときにmongosync オプションを使用して構成ファイルへのパスを設定した場合は、この構成ファイルを各設定の新しい値で更新します。

4

mongosync前のステップで構成ファイルを更新した場合は、更新された構成ファイルのパスに設定した--config オプションを使用して プロセスを初期化します。

mongosync --config <configPath>

最初に--config を初期化したときにmongosync オプションを使用しなかった場合は、コマンドラインオプションを更新した値に設定してmongosync プロセスを初期化します。

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

詳細については、「 mongosync を初期化する 」を参照してください。

5

mongosync任意の最初のステップの前半で プロセスを一時停止した場合は、一時停止したresume mongosyncプロセスで を実行します。

mongosyncを使用せずにpause プロセスを停止した場合は、停止したstart mongosyncプロセスで を実行します。詳しくは、「 クラスター間でデータを同期する 」を参照してください。

mongosync は、以前のプロセスを停止する前の状態から同期をほぼ再開します。 終了時に進行中であったパーティションは、最初から再起動します。