MongoDB Agent の設定

LoggingSettings

logFile

型: string

MongoDB Ops ManagerがMongoDB Agentのログを書き込むパスを指定します。

デフォルトのパスはプラットフォームによって異なります。 MongoDB Agent は、配置でオートメーションが使用されるかどうかにかかわらず、デフォルトのファイル名automation-agent.logを使用します。

重要

MongoDB Agent ログの自動ローテーションは、ログファイルの更新が行われた場合にのみ発生します。 MongoDB Agent ログを手動でローテーションする方法の詳細については、「 MongoDB Agent ログの手動ローテーション」を参照してください。

プラットフォーム	デフォルト パス
Linux	/var/log/mongodb-mms-automation/automation-agent.log
Windows	C:\MMSAutomation\log\mongodb-mms-automation\automation-agent.log

logFile=/path/to/mongodb-mms-automation/automation-agent.log

logLevel

型: string

ログの粒度のレベルを指定します。

警告

Monitoring Agent Log LevelとAutomation Agent Log LevelのAdmin Project Settings （プロジェクト設定） は、このパラメータを上書きします。

次の重大度レベルから、情報の量が多い順に選択します。

• DEBUG

• INFO

• WARN

• ERROR

• FATAL

デフォルトでは、 logLevelはINFOです。

logLevel=ROUTINE

各レベルには、連続するレベルに含まれるログ項目が含まれます。

例

• DEBUGを選択すると、MongoDB Agent はINFO 、 WARN 、 ERROR 、 FATALなど、すべてのメッセージをログに記録します。

• FATALを選択した場合、MongoDB Agent はFATALメッセージのみをログに記録します。

maxLogFiles

タイプ: 整数

保持するローテーション ログ ファイルの最大数を指定します。

デフォルトでは、 maxLogFiles 10に設定されています。 値を変更すると、ローテーションされたログファイルの別の数が保持できます。

maxLogFiles=15

maxLogFileDurationHrs

型: float

ログがローテーションされる時間数を指定します。

注意

MongoDB Agent ログの手動ローテーション

UNIX および Linux ベースのシステムでは、MongoDB Agent ログを手動でローテーションできます。 エージェント プロセス向けに、 SIGUSR1シグナルとともにkillコマンドを発行します。

kill -SIGUSR1 <AgentID>

Windows ベースのシステムでは、サービスの再起動を使用して MongoDB Agent を手動で再起動できます。

1. Startメニューをクリックします。

2. servicesを検索します。

3. MongoDB Agent を見つけます。

4. エージェントを右クリックし、[ Restart ] をクリックします。

これにより、MongoDB Agent ログがローテーションされます。

maxLogFileSize

タイプ: 整数

ログがローテーションされる前にログファイルの最大サイズをバイト単位で指定します。 指定されていない場合、MongoDB Agent はファイル サイズに基づいてログをローテーションしません。

maxLogFileSize=536870912

maxUncompressedLogFiles

タイプ: 整数

非圧縮に保持するローテーション ログ ファイルの最大数を指定します。 MongoDB Agent は、保持された追加のログファイルをmaxLogFiles値まで自動的に圧縮します。

デフォルトでは、 maxUncompressedLogFiles 2に設定されています。 値を変更すると、ローテーションされたログファイルの別の数が圧縮されます。

maxUncompressedLogFiles=10

接続設定

dialTimeoutSeconds

タイプ: 整数

接続のタイムアウトまでの待ち時間を秒単位で指定します。 デフォルトでは、接続は 40 秒後にタイムアウトします。 ただし、次の 1 つ以上の理由で、MongoDB Agent は頻繁に接続をタイムアウトすることがあります。

• 高ネットワーク レイテンシ

• 高負荷

• 大規模なTLSキー

• TLSアクティベーションの欠落

• CPU 速度が不十分

MongoDB では、接続タイムアウトが頻繁に発生するのを防ぐために、 dialTimeoutSeconds MongoDB Agent の構成設定の値を徐々に増やしていくことをお勧めします。

dialTimeoutSeconds=40

注意

この値を大きくすると、MongoDB Agent への構成変更の配置に必要な時間も長くなります。 配置に最適な値を決定するまで、小さなインクリメンタル 増加 を試してください。

serverSelectionTimeoutSeconds

タイプ: 整数

MongoDB Agent が MongoDB プロセスへの接続を確立するまでの待機時間を秒単位で指定します。 デフォルトでは、MongoDB Agent は 10 秒後に接続を確立しようとします。

serverSelectionTimeoutSeconds=10

HTTP proxy設定

httpProxy

型: string

MongoDB Agent が使用できる HTTP プロキシ サーバーの URL を指定します。

httpProxy=http://proxy.example.com:8080

構成バックアップ設定

mmsConfigBackup

型: string

MongoDB Ops Manager構成バックアップ ファイルへのパスを指定します。 このファイルには、配置の希望状態が記述されています。

mmsConfigBackup設定を指定しない場合、MongoDB Agent はmongodb-mms-automation-cluster-backup.jsonファイルをオペレーティング システム上の一時フォルダーに書込みます。

enableLocalConfigurationServerをtrueに設定すると、MongoDB Agent はmmsConfigBackupファイルを書込みません。

mmsConfigBackup=/path/to/mms-cluster-config-backup.json

注意

MongoDB Ops Managerがインストールされると、プラットフォームに応じて次のいずれかの場所に構成バックアップ ファイルが保存されます。

プラットフォーム	構成バックアップ ファイル パス
Linux	/var/lib/mongodb-mms-automation/
Windows	%SystemDrive%\MMSAutomation

MongoDB Ops ManagerTLS 設定

MongoDB Agent がTLSを使用して MongoDB Ops Manager と通信するときに使用する設定を指定します。

httpsCAFile

型: string

PEM形式の信頼できる証明機関証明書を含む絶対パスを指定します。 この証明書は、MongoDB Agent が指定された MongoDB Ops Manager インスタンスと通信していることを確認します。

httpsCAFile=/path/to/ca.pem

注意

次の場合は、 downloads.mongodb.com証明書の証明機関をこの.pemファイルに追加します。

1. MongoDB エージェントがインターネットから MongoDB インストーラーをダウンロードする必要がある。

2. TLS を使用して接続を暗号化する

3. プライベート証明機関で証明書に署名しました。 （ httpsCAFileオプションを設定します）

別のウェブ サイトから TLS 証明書をダウンロードする方法については、 OpenSSL Atlas Charts のエントリ を参照してください。

重要

MongoDB Ops Manager が起動すると、指定した認証局がキャッシュされます。 認証局証明書を変更する場合は、 MongoDB Ops Managerを再起動します。

sslRequireValidMMSServerCertificates

タイプ: ブール値

重要

非推奨。 代わりにtlsRequireValidMMSServerCertificatesを使用してください。

tlsRequireValidMMSServerCertificates

タイプ: ブール値

MongoDB Agent が MongoDB Ops Manager によって提示されたTLS証明書を検証するかどうかを指定します。

警告

このオプションをfalseに設定すると、証明書の検証が無効になり、MongoDB Agent と MongoDB Ops Manager 間の接続は中間者攻撃（man-in-the-middle attack）の影響を受けやすくなります。 このオプションをfalseに設定することは、テスト目的でのみ推奨されます。

tlsRequireValidMMSServerCertificates=true

sslMMSServerClientCertificate

型: string

重要

非推奨。 代わりにtlsMMSServerClientCertificateを使用してください。

tlsMMSServerClientCertificate

型: string

クライアントの秘密キー、証明書、オプションの中間証明書を含むファイルへのパスをPEM形式で指定します。 は、MongoDB Agent MongoDB Ops ManagerTLS 経由でMongoDB Ops Manager に接続するときにクライアント証明書を使用します。たとえば、MongoDB Ops Manager Client Certificate Modeがクライアント証明書を必要とする場合（Required for Agents Only が を またはRequired for All Requests に設定して実行されている場合などです。

Tip

以下も参照してください。

Client Certificate Modeを設定する方法については、「 MongoDB Ops Managerの構成設定 」を参照してください。

証明書ファイルの暗号化された秘密キーは、.pem PKCS #1 に含まれている必要があります。 形式。MongoDB Agent は PKCS #8 をサポートしていません。 形式。

tlsMMSServerClientCertificate=/path/to/client.pem

sslMMSServerClientCertificatePassword

型: string

重要

非推奨。 代わりにtlsMMSServerClientCertificatePasswordを使用してください。

tlsMMSServerClientCertificatePassword

型: string

tlsMMSServerClientCertificateファイル内の秘密キーを復号化するために必要なパスワードを指定します。 この設定は、クライアント証明書PEMファイルが暗号化されている場合に必要です。

証明書ファイルの暗号化された秘密キーは、.pem PKCS #1 に含まれている必要があります。 形式。MongoDB Agent は PKCS #8 をサポートしていません。 形式。

注意

shell tlsMMSServerClientCertificatePasswordExectlsMMSServerClientCertificatePasswordコマンドからパスワードを指定するには、 ではなく オプションを使用します。

tlsMMSServerClientCertificatePassword=password

sslServerClientCertificate

型: string

クライアントの秘密キー、証明書、オプションの中間証明書を含むファイルへのパスをPEM形式で指定します。 は、MongoDB Agent MongoDB Ops ManagerTLS 経由でMongoDB Ops Manager に接続するときにクライアント証明書を使用します。たとえば、MongoDB Ops Manager Client Certificate Modeがクライアント証明書を必要とする場合（Required for Agents Only が を またはRequired for All Requests に設定して実行されている場合などです。

Tip

以下も参照してください。

• アプリケーションでこの設定を指定する方法については、 Client Certificate ModeMongoDB Ops Manager「 構成設定MongoDB Ops Manager 」の を参照してください。

• MongoDB Agent の TLS 接続を有効にするには 、「 TLS を使用するように MongoDB Agent を構成する 」を参照してください。

sslServerClientCertificate=/path/to/client.pem

sslServerClientCertificatePassword

sslServerClientCertificateファイル内の秘密キーを復号化するために必要なパスワードを指定します。 この設定は、クライアント証明書PEMファイルが暗号化されている場合に必要です。

sslServerClientCertificatePassword=password

sslRequireValidMMSBackupServerCertificate

MongoDB Agent が MongoDB Ops Manager からのTLS証明書を検証するかどうかを指定します。

警告

このオプションをfalseに設定すると、証明書の検証が無効になり、MongoDB Agent と MongoDB Ops Manager 間の接続は中間者攻撃（man-in-the-middle attack）の影響を受けやすくなります。 このオプションをfalseに設定することは、テスト目的でのみ推奨されます。

sslRequireValidMMSBackupServerCertificate=true

プッシュ ライブ移行設定

agentFeatureCloudMigrationEnabled

タイプ: ブール値

任意。

移行ホスト 上のMongoDB Agent が、ソースMongoDB Ops Manager の配置から のターゲットクラスターへの ライブ移行Atlas プロセスを実行するように構成されているかどうかを指定します。

このオプションのデフォルトはfalseになり、Atlas へのライブ移行にはこのホストで MongoDB Agent を使用できなくなります。

ライブ移行プロセスを有効にするには、移行ホストをプロビジョニングし、 agentFeatureCloudMigrationEnabledをtrueに設定します。

cloudMigrationOplogPath

型: string

任意。

oplogファイルへのパス。 指定されている場合、この設定はディスクへの最初の同期のoplog window をバッファします。 指定されたディレクトリ内にoplogバッファリング用に十分なストレージをプロビジョニングします。

外部ソースの構成設定

enableLocalConfigurationServer

タイプ: ブール値

MongoDB Agent が MongoDB プロセス構成ファイルをディスクに保存するか、メモリにキャッシュして保存するかを指定します。

このオプションのデフォルトはfalseで、構成ファイルをディスクに保存します。 このオプションをtrueに設定すると、構成がメモリにキャッシュされます。

このオプションをtrueに設定すると、MongoDB Agent はmmsConfigBackupファイルを書込みません。

MongoDB データベースでFCV 4.2またはそれ以前のバージョンが実行されている場合は、このオプションをtrueに設定しないでください。

警告

このオプションをtrueに設定すると、配置の可用性に影響します。

この機能を有効にすると、MongoDB Agent は MongoDB プロセス構成をディスクに保存しません。 If the Ops Manager app server is unavailable and the MongoDB Agent attempts to restart, then the MongoDB Agent stops running because it doesn't have the necessary configuration information. MongoDB Agent が実行されていないときに MongoDB プロセスがクラッシュした場合、MongoDB Agent はプロセスを再開できません。

enableLocalConfigurationServer=false

Tip

以下も参照してください。

MongoDB Agent による構成ファイルとパスワードの管理方法の設定

keepUnusedMongodbVersions

タイプ: ブール値

MongoDB Agent がダウンロードした未使用の MongoDB バージョン バイナリを保持するかどうかを示すフラグ。 デフォルトでは、 keepUnusedMongodbVersionsは false です。

keepUnusedMongodbVersions=false

localConfigurationServerPort

タイプ: 整数

ローカル 構成サーバー を使用する場合に MongoDB プロセス構成を提供するポートを指定します。 このオプションを設定するには、 enableLocalConfigurationServerがtrueである必要があります。

指定されていない場合、MongoDB Agent は使用可能なポートを自動的に選択します。

localConfigurationServerPort=20128

mmsApiKeyExec

型: string

プロジェクトの エージェントshell キーを呼び出すためのMongoDB Ops Manager APIコマンドを指定します。MongoDB Ops Manager

mmsApiKeyExec=echo $myKey

sslMMSServerClientCertificatePasswordExec

型: string

重要

非推奨。 代わりにtlsMMSServerClientCertificatePasswordExecを使用してください。

tlsMMSServerClientCertificatePasswordExec

型: string

MMSServerClientCertificateファイル内の秘密キーを復号化するために必要なパスワードを呼び出すための shell コマンドを指定します。 クライアント証明書PEMファイルが暗号化されている場合は、この設定またはtlsMMSServerClientCertificatePasswordのいずれかが必要です。

tlsMMSServerClientCertificatePasswordExec=python /path/to/PEMPassword.py

MongoDB Kerberos 設定

オートメーションが Kerberos を使用してホストを認証する場合は、これらの設定を指定します。 Kerberos を構成するには、「 Kerberos用の MongoDB Agent の構成 」を参照してください。

krb5ConfigLocation

型: string

Kerberos 構成ファイルの非システム標準の場所への絶対パスを指定します。

krb5ConfigLocation=/path/to/krb_custom.conf

注意

MongoDB Ops Managerは、 Kerberosが有効になっている場合、各エージェントに対してKerberos認証情報（チケット）キャッシュを自動的に作成します。 Kerberos 認証情報キャッシュ の場所を上書きする場合 、エージェントを実行する前に、KRB5CCNAME 環境変数を目的のファイル名とパスに設定する必要があります。

backupAgentKrb5CCName

Type string

バックアップ プロセスのために MongoDB Agent が設定するKRB5CC環境変数を指定します。 MongoDB Agent がバックアップ機能を開始するときに、MongoDB 配置へのバックアップを認証するためにのみ使用されます。

backupAgentKrb5CCName=/path/to/credentials_cache_file

monitoringAgentKrb5CCName

Type string

MongoDB Agent がモニタリング 関数用に設定するKRB5CC環境変数を指定します。 MongoDB Agent がモニタリング機能を開始するときに、MongoDB 配置へのモニタリングを認証するためにのみ使用されます。

monitoringAgentKrb5CCName=/path/to/credentials_cache_file

ログ設定

1. ナビゲーションで、[ Deployment ] をクリックします。

2. [Agents] タブをクリックします。

3. [Downloads & Settings] をクリックします。

4. Agent Log Settingsセクションで、 Monitoring Log Settingsの横にある。

5. モニタリング ログ設定を編集します。

   設定	デフォルト値	コンソールの推奨値
   Linux ログファイル パス	/var/log/mongodb-mms-automation/monitoring-agent.log
   Windows ログファイルパス	%SystemDrive%\MMSAutomation\log\mongodb-mms-automation\monitoring-agent.log
   ログのローテーション	はい
   サイズしきい値（MB）	1000
   時間しきい値（時間）	24
   Max 非圧縮ファイル		5
   Max Percent of Disk		2
   ログファイルの合計数	0

6. [Save] をクリックします。

カスタム設定

1. ナビゲーションで、[ Deployment ] をクリックします。

2. [Agents] タブをクリックします。

3. [Downloads & Settings] をクリックします。

4. Custom Configurationセクションで、 Edit Custom Configurationsの横にある次をクリックします。

5. 監視構成の設定と値を入力します。

6. [Save and Close] をクリックします。

次のモニタリング設定を構成できます。

ログ設定

1. ナビゲーションで、[ Deployment ] をクリックします。

2. [Agents] タブをクリックします。

3. [Downloads & Settings] をクリックします。

4. Agent Log Settingsセクションで、 Backup Log Settingsの横にある。

5. バックアップログ設定を編集します。

   設定	デフォルト値	コンソールの推奨値
   Linux ログファイル パス	/var/log/mongodb-mms-automation/backup-agent.log
   Windows ログファイルパス	%SystemDrive%\MMSAutomation\log\mongodb-mms-automation\backup-agent.log
   ログのローテーション	はい
   サイズしきい値（MB）	1000
   時間しきい値（時間）	24
   Max 非圧縮ファイル		5
   Max Percent of Disk		2
   ログファイルの合計数	0

6. [Save] をクリックします。

カスタム設定

1. ナビゲーションで、[ Deployment ] をクリックします。

2. [Agents] タブをクリックします。

3. [Downloads & Settings] をクリックします。

4. Custom Configurationセクションで、 Edit Custom Configurationsの横にある次をクリックします。

5. バックアップ の構成設定と値を入力します。

6. [Save and Close] をクリックします。

次のバックアップ設定を構成できます。