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 の再構成」を参照してください。

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

--disableMetricsLogging

バージョン1.16.0の新機能。

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

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

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

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

--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 に出力します。

--hotDocIDs

ホットドキュメント、またはソースクラスター上で非常に頻繁にアップデートされるドキュメントの識別子を設定します。

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 を再起動します。

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

バージョン1.18の新機能。

--id <id>

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

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

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

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

--loadLevel <level>

タイプ: 整数

デフォルト: 3

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

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

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

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

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

警告

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

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

バージョン 1.4 で追加。

--logPath <directory>

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

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

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

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

注意

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

kill -s USR1 $mongosync_pid

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

--metricsLoggingFilepath <directory>

バージョン1.16.0の新機能。

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

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

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

--port

デフォルト: 27182

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

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

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

--verbosity <level>

デフォルト: DEBUG

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

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

• TRACE

• DEBUG

• INFO

• WARN

• ERROR

• FATAL

• PANIC

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

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

--version, -v

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