MongoDB 助手设置

LoggingSettings

logFile

类型：字符串

指定 Ops Manager 应写入 MongoDB 助手的日志的路径。

默认路径取决于您的平台。无论部署是否使用自动化，MongoDB 助手都会使用默认文件名 automation-agent.log。

重要

仅当更新日志文件时，才会自动轮换 MongoDB 助手日志。要手动轮换 MongoDB 助手日志，请参阅手动轮换 MongoDB 助手日志以了解更多信息。

平台	默认路径
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

类型：字符串

指定日志记录粒度的级别。

警告

Monitoring Agent Log Level 和 Automation Agent Log Level 的管理项目设置会覆盖此参数。

从以下严重性级别中选择（信息量从多到少）：

• DEBUG

• INFO

• WARN

• ERROR

• FATAL

默认情况下， logLevel为INFO 。

logLevel=ROUTINE

每个级别都包含后续级别中包含的日志项。

例子

• 如果选择 DEBUG（调试），则 MongoDB 助手会记录所有消息，包括 INFO、WARN、ERROR 和 FATAL。

• 如果您选择 FATAL，则 MongoDB 助手仅记录 FATAL 消息。

maxLogFiles

类型：整型

指定要保留的轮换日志文件的最大数量。

默认情况下， maxLogFiles的值设置为10 。您可以更改该值以保留不同数量的轮换日志文件。

maxLogFiles=15

maxLogFileDurationHrs

类型：浮点

指定距离下一次日志轮换的小时数。

注意

手动轮换 MongoDB 助手日志

在基于 UNIX 和 Linux 的系统上，您可以手动轮换 MongoDB 助手日志。为代理进程发出带有 SIGUSR1 信号的 kill 命令：

kill -SIGUSR1 <AgentID>

在基于 Windows 的系统上，您可以通过服务重启来手动重启 MongoDB 助手：

1. 单击 Start（启动）菜单。

2. 搜索 services（服务）。

3. 找到 MongoDB 助手。

4. 右键单击该代理，然后单击 Restart（重新启动）。

这将轮换 MongoDB 助手日志。

maxLogFileSize

类型：整型

指定日志轮换前日志文件的最大大小（以字节为单位）。如果未指定，MongoDB 助手不会根据文件大小轮换日志。

默认情况下， maxLogFileSize的值设置为268435456字节。您可以更改该值，为日志文件指定不同的最大大小。

maxLogFileSize=536870912

maxUncompressedLogFiles

类型：整型

指定要保持未压缩状态的轮换日志文件的最大数量。 MongoDB 助手会自动将任何额外保留的日志文件压缩到maxLogFiles值。

默认情况下， maxUncompressedLogFiles的值设置为2 。您可以更改该值以压缩不同数量的轮换日志文件。

maxUncompressedLogFiles=10

连接设置

dialTimeoutSeconds

类型：整型

指定连接超时前的等待秒数。默认情况下，连接会在 40 秒后超时。但是，MongoDB 助手可能会由于以下一个或多个原因而频繁出现连接超时：

• 高网络延迟

• 服务器负载过高

• 大型 TLS 密钥

• 缺少 TLS 加速器

• CPU 速度不足

MongoDB 建议逐渐增加dialTimeoutSeconds MongoDB 助手配置设置的值，以防止连接频繁地过早超时。

dialTimeoutSeconds=40

注意

增加此值，还会增加将配置更改部署到 MongoDB 助手所需的时间。尝试小幅递增，直到确定部署的最佳值。

serverSelectionTimeoutSeconds

类型：整型

指定 MongoDB 助手在停止尝试与 MongoDB 进程建立连接之前等待的秒数。默认情况下，MongoDB 助手会在 10 秒后放弃建立连接的尝试。

serverSelectionTimeoutSeconds=10

HTTP 代理设置

httpProxy

类型：字符串

指定 MongoDB 助手可以使用的 HTTP 代理服务器的 URL。

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

配置备份设置

mmsConfigBackup

类型：字符串

指定 Ops Manager配置备份文件的路径。此文件描述部署的预期状态。

如果不指定mmsConfigBackup设置，MongoDB 助手会将mongodb-mms-automation-cluster-backup.json文件写入操作系统上的临时文件夹。

如果将enableLocalConfigurationServer设置为true ，则 MongoDB 助手不会写入mmsConfigBackup文件。

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

注意

安装 Ops Manager 后，它会将配置备份文件存储在以下位置之一，具体取决于您的平台：

平台	配置备份文件路径
Linux	/var/lib/mongodb-mms-automation/
Windows	%SystemDrive%\MMSAutomation

Ops Manager TLS设置

指定 MongoDB 助手通过 TLS 与 Ops Manager 通信时使用的设置。

httpsCAFile

类型：字符串

指定包含 PEM 格式的受信任证书颁发机构证书的绝对路径。此证书验证 MongoDB 助手是否正在与指定的 Ops Manager 实例通信。

httpsCAFile=/path/to/ca.pem

注意

如果您执行以下操作，请将 downloads.mongodb.com 证书的证书颁发机构添加到此 .pem 文件：

1. 需要 MongoDB 助手从互联网上下载 MongoDB 安装程序，

2. 使用 TLS 加密连接，以及

3. 使用私人证书颁发机构签署证书。（您设置了 httpsCAFile 选项。）

要了解如何从其他网站下载 TLS 证书，请参阅 OpenSSL Cookbook 条目。

重要

当 Ops Manager 启动时，它会缓存您提供的证书颁发机构。如果更改证书颁发机构证书，请重新启动 Ops Manager。

sslRequireValidMMSServerCertificates

类型：布尔值

重要

已弃用。请改用tlsRequireValidMMSServerCertificates 。

tlsRequireValidMMSServerCertificates

类型：布尔值

指定 MongoDB 助手是否应验证 Ops Manager 提供的 TLS 证书。

警告

将此选项设置为 false 会禁用证书验证，并导致 MongoDB 助手和 Ops Manager 之间的连接容易受到中间人攻击。建议仅出于测试目的将此选项设置为 false。

tlsRequireValidMMSServerCertificates=true

sslMMSServerClientCertificate

类型：字符串

重要

已弃用。请改用tlsMMSServerClientCertificate 。

tlsMMSServerClientCertificate

类型：字符串

以 PEM 格式指定包含客户端私钥、证书和可选中间证书的文件路径。在通过 TLS 连接到 Ops Manager 时，如果 Ops Manager 要求客户端证书（例如在 Client Certificate Mode 设置为 Required for Agents Only 或 Required for All Requests 时运行 Ops Manager），那么 MongoDB 助手就会使用客户端证书。

提示

另请参阅：

要了解如何设置 Client Certificate Mode，请参阅 Ops Manager 配置设置。

注意

.pem证书文件的加密私钥必须采用 PKCS #1 格式。 MongoDB 助手不支持 PKCS #8 格式。

tlsMMSServerClientCertificate=/path/to/client.pem

sslMMSServerClientCertificatePassword

类型：字符串

重要

已弃用。请改用tlsMMSServerClientCertificatePassword 。

tlsMMSServerClientCertificatePassword

类型：字符串

指定解密tlsMMSServerClientCertificate文件中的私钥所需的密码。加密客户端证书PEM文件时，需要此设置。

注意

.pem证书文件的加密私钥必须采用 PKCS #1 格式。 MongoDB 助手不支持 PKCS #8 格式。

注意

使用tlsMMSServerClientCertificatePasswordExec选项而不是tlsMMSServerClientCertificatePassword来指定 shell 命令中的密码。

tlsMMSServerClientCertificatePassword=password

sslServerClientCertificate

类型：字符串

以 PEM 格式指定包含客户端私钥、证书和可选中间证书的文件路径。在通过 TLS 连接到 Ops Manager 时，如果 Ops Manager 要求客户端证书（例如在 Client Certificate Mode 设置为 Required for Agents Only 或 Required for All Requests 时运行 Ops Manager），那么 MongoDB 助手就会使用客户端证书。

提示

另请参阅：

• 有关如何在 Ops Manager 应用程序中指定此设置，请参阅 Ops Manager 配置设置中的 Client Certificate Mode。

• 请参阅配置 MongoDB 助手以使用 TLS，为 MongoDB 助手启用 TLS 连接。

sslServerClientCertificate=/path/to/client.pem

sslServerClientCertificatePassword

指定解密 sslServerClientCertificate 文件中的私钥所需的密码。加密客户端证书 PEM 文件时，需要此设置。

sslServerClientCertificatePassword=password

sslRequireValidMMSBackupServerCertificate

指定 MongoDB 助手是否应验证来自 Ops Manager 的 TLS 证书。

警告

将此选项设置为 false 会禁用证书验证，并导致 MongoDB 助手和 Ops Manager 之间的连接容易受到中间人攻击。建议仅出于测试目的将此选项设置为 false。

sslRequireValidMMSBackupServerCertificate=true

推送实时迁移设置

agentFeatureCloudMigrationEnabled

类型：布尔值

可选。

指定迁移主机上的 MongoDB 助手是否配置为运行从源 Ops Manager 部署到 Atlas 中目标集群的实时迁移进程。

此选项默认为 false，这将阻止在此主机上使用 MongoDB 助手进行到 Atlas 的实时迁移。

要启用实时迁移进程，请预配迁移主机并将 agentFeatureCloudMigrationEnabled 设置为 true。

cloudMigrationOplogPath

类型：字符串

可选。

oplog文件的路径。如果指定，此设置会将初始同步oplog窗口缓冲到磁盘。在指定目录中为oplog缓冲预配足够的存储空间。

源自外部的配置设置

enableLocalConfigurationServer

类型：布尔值

指定 MongoDB 助手是将 MongoDB 进程配置文件存储在磁盘上还是缓存在内存中。

此选项默认为 false，将配置文件存储在磁盘上。将此选项设置为 true 会将配置缓存在内存中。

如果将此选项设置为true ，则 MongoDB 助手不会写入mmsConfigBackup文件。

如果 MongoDB 数据库运行的是 FCV ，请勿将此选项设置为true4 。2 或更早版本。

警告

将此选项设置为 true 会影响部署的可用性。

启用此功能后，MongoDB 助手不会将 MongoDB 进程配置存储到磁盘。如果 Ops Manager 应用程序服务器不可用，并且 MongoDB 助手尝试重新启动，则因为没有必要的配置信息，MongoDB 助手将停止运行。如果 MongoDB 进程在 MongoDB 助手未运行时崩溃，则 MongoDB 助手无法重新启动该进程。

enableLocalConfigurationServer=false

提示

另请参阅：

配置 MongoDB 助手如何管理配置文件和密码

keepUnusedMongodbVersions

类型：布尔值

指示 MongoDB 助手是否保留其下载的未使用的 MongoDB 版本二进制文件的标志。默认情况下， keepUnusedMongodbVersions为 false。

keepUnusedMongodbVersions=false

localConfigurationServerPort

类型：整型

指定使用本地配置服务器时为 MongoDB 进程配置提供服务的端口。要设置此选项， enableLocalConfigurationServer必须为true 。

如果未指定，则 MongoDB 助手会自动选择可用端口。

localConfigurationServerPort=20128

mmsApiKeyExec

类型：字符串

指定一个 Shell 命令来调用 Ops Manager 项目的 Ops Manager 代理 API 密钥。

mmsApiKeyExec=echo $myKey

sslMMSServerClientCertificatePasswordExec

类型：字符串

重要

已弃用。请改用tlsMMSServerClientCertificatePasswordExec 。

tlsMMSServerClientCertificatePasswordExec

类型：字符串

指定 shell 命令来调用解密MMSServerClientCertificate文件中的私钥所需的密码。加密客户端证书PEM文件时，需要此设置或tlsMMSServerClientCertificatePassword 。

tlsMMSServerClientCertificatePasswordExec=python /path/to/PEMPassword.py

MongoDB Kerberos 设置

如果自动化使用 Kerberos 对主机进行身份验证，请指定这些设置。要配置 Kerberos，请参阅为 Kerberos 配置 MongoDB 助手。

krb5ConfigLocation

类型：字符串

指定 Kerberos 配置文件的非系统标准位置的绝对路径。

krb5ConfigLocation=/path/to/krb_custom.conf

注意

启用 Kerberos 后，Ops Manager 会自动为每个代理创建 Kerberos 凭证（票证）缓存。如果要覆盖 Kerberos 档案缓存 的位置 ，您必须在运行代理之前将KRB5CCNAME 环境变量设置为所需的文件名和路径。

backupAgentKrb5CCName

类型字符串

指定 MongoDB 助手为备份进程设置的 KRB5CC 环境变量。仅用于在 MongoDB 助手启动备份功能时验证 MongoDB 部署的备份。

backupAgentKrb5CCName=/path/to/credentials_cache_file

monitoringAgentKrb5CCName

类型字符串

指定 MongoDB 助手为监控功能设置的 KRB5CC 环境变量。仅用于当 MongoDB 助手启动监控功能时对 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
   最大未压缩文件数		5
   最大磁盘百分比		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
   最大未压缩文件数		5
   最大磁盘百分比		2
   日志文件总数	0

6. 单击 Save（连接）。

自定义设置

1. 在导航菜单中，单击 Deployment（部署）。

2. 单击 Agents 标签页。

3. 单击 Downloads & Settings（连接）。

4. 在 Custom Configuration（自定义配置）部分的 Edit Custom Configurations（编辑自定义配置）旁边，单击 。

5. 输入备份配置设置和值。

6. 单击 Save and Close（连接）。

您可以配置以下备份设置：