MongoDB Agent Settings

Logging Settings

logFile

Type: string

Specifies the path to which Ops Manager should write the MongoDB Agent's log.

The default path depends on your platform. The MongoDB Agent uses the default filename automation-agent.log whether or not the deployment uses Automation.

Important

Automatic rotation of your MongoDB Agent logs only occurs when an update to the log file is made. To manually rotate your MongoDB Agent logs, see Manually Rotate the MongoDB Agent Logs for more information.

Platform	Default Path
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

Type: string

Specifies the level of logging granularity.

Warning

The Admin Project Settings for Monitoring Agent Log Level and Automation Agent Log Level override this parameter.

Choose from the following severity levels, from most to least amount of information:

• DEBUG

• INFO

• WARN

• ERROR

• FATAL

By default, logLevel is INFO.

logLevel=ROUTINE

Each level includes the log items included in the succeeding levels.

Example

• If you choose DEBUG, the MongoDB Agent logs all messages, including INFO, WARN, ERROR and FATAL.

• If you choose FATAL, the MongoDB Agent only logs FATAL messages.

maxLogFiles

Type: integer

Specifies the maximum number of rotated log files to retain.

By default, the value of maxLogFiles is set to 10. You can change the value to retain a different number of rotated log files.

maxLogFiles=15

maxLogFileDurationHrs

Type: float

Specifies the number of hours after which the logs are rotated.

Note

Manually Rotate the MongoDB Agent Logs

On UNIX- and Linux-based systems you can manually rotate the MongoDB Agent logs. Issue a kill command with the SIGUSR1 signal for the Agent process:

kill -SIGUSR1 <AgentID>

On Windows-based systems, you can manually restart the MongoDB Agent with a Service restart:

1. Click the Start menu.

2. Search for services.

3. Find the MongoDB Agent.

4. Right-click on the Agent and click Restart.

This rotates the MongoDB Agent logs.

maxLogFileSize

Type: integer

Specifies the maximum size, in bytes, of a log file before the logs are rotated. If unspecified, the MongoDB Agent does not rotate logs based on file size.

By default, the value of maxLogFileSize is set to 268435456 bytes. You can change the value to assign a different maximum size for a log file.

maxLogFileSize=536870912

maxUncompressedLogFiles

Type: integer

Specifies the maximum number of rotated log files to keep uncompressed. MongoDB Agent automatically compresses any additional retained log files up to the maxLogFiles value.

By default, the value of maxUncompressedLogFiles is set to 2. You can change the value to compress a different number of rotated log files.

maxUncompressedLogFiles=10

Connection Settings

dialTimeoutSeconds

Type: integer

Specifies the number of seconds to wait before a connection times out. By default, connections time out after 40 seconds. However, The MongoDB Agent may frequently time out of connections for one or more of the following reasons:

• High network latency

• High server load

• Large TLS keys

• Lack of TLS accelerator

• Insufficient CPU speed

MongoDB recommends gradually increasing the value of the dialTimeoutSeconds MongoDB Agent configuration setting to prevent frequent premature connection timeouts.

dialTimeoutSeconds=40

Note

Increasing this value also increases the time required to deploy configuration changes to the MongoDB Agent. Experiment with small, incremental increases until you determine the optimum value for your deployment.

serverSelectionTimeoutSeconds

Type: integer

Specifies the number of seconds the MongoDB Agent waits before it stops trying to establish a connection to a MongoDB process. By default, the MongoDB Agent abandons attempts to establish a connection after 10 seconds.

serverSelectionTimeoutSeconds=10

HTTP Proxy Settings

httpProxy

Type: string

Specifies the URL of an HTTP proxy server the MongoDB Agent can use.

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

Configuration Backup Settings

mmsConfigBackup

Type: string

Specifies the path to the Ops Manager configuration backup file. This file describes the desired state of the deployment.

If you don't specify the mmsConfigBackup setting, the MongoDB Agent writes the mongodb-mms-automation-cluster-backup.json file to a temporary folder on the operating system.

If you set enableLocalConfigurationServer to true, the MongoDB Agent doesn't write the mmsConfigBackup file.

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

Note

When Ops Manager is installed, it stores the configuration backup file is stored in one of the following places, depending on your platform:

Platform	Configuration Backup File Path
Linux	/var/lib/mongodb-mms-automation/
Windows	%SystemDrive%\MMSAutomation

Ops Manager TLS Settings

Specify the settings that the MongoDB Agent uses when communicating with Ops Manager using TLS.

httpsCAFile

Type: string

Specifies the absolute path that contains the trusted Certificate Authority certificates in PEM format. This certificate verifies that the MongoDB Agent is talking to the designated Ops Manager instance.

httpsCAFile=/path/to/ca.pem

Note

Add the Certificate Authority for the downloads.mongodb.com certificate to this .pem file if you:

1. Need your MongoDB Agents to download their MongoDB installers from the Internet,

2. Use TLS to encrypt connections, and

3. Signed your certificates with a private Certificate Authority. (You set the httpsCAFile option.)

To learn how to download TLS certificates from another web site, see the OpenSSL Cookbook entry.

Important

When Ops Manager starts, it caches the Certificate Authority you provided. If you change your Certificate Authority certificate, restart Ops Manager.

sslRequireValidMMSServerCertificates

Type: boolean

Important

Deprecated. Use tlsRequireValidMMSServerCertificates instead.

tlsRequireValidMMSServerCertificates

Type: boolean

Specifies if the MongoDB Agent should validate TLS certificates presented by Ops Manager.

Warning

Setting this option to false disables certificate verification and makes connections between the MongoDB Agent and Ops Manager susceptible to man-in-the-middle attacks. Setting this option to false is only recommended for testing purposes.

tlsRequireValidMMSServerCertificates=true

sslMMSServerClientCertificate

Type: string

Important

Deprecated. Use tlsMMSServerClientCertificate instead.

tlsMMSServerClientCertificate

Type: string

Specifies the path to the file containing the client's private key, certificate, and optional intermediate certificates in PEM format. The MongoDB Agent uses the client certificate when connecting to Ops Manager over TLS if Ops Manager requires client certificates, such as when Ops Manager runs with Client Certificate Mode set to Required for Agents Only or Required for All Requests.

Tip

See also:

To learn how to set Client Certificate Mode, see Ops Manager Configuration Settings.

The encrypted private key for the .pem certificate file must be in PKCS #1 format. The MongoDB Agent doesn't support the PKCS #8 format.

tlsMMSServerClientCertificate=/path/to/client.pem

sslMMSServerClientCertificatePassword

Type: string

Important

Deprecated. Use tlsMMSServerClientCertificatePassword instead.

tlsMMSServerClientCertificatePassword

Type: string

Specifies the password needed to decrypt the private key in the tlsMMSServerClientCertificate file. This setting is required when the client certificate PEM file is encrypted.

The encrypted private key for the .pem certificate file must be in PKCS #1 format. The MongoDB Agent doesn't support the PKCS #8 format.

Note

Use the tlsMMSServerClientCertificatePasswordExec option instead of tlsMMSServerClientCertificatePassword to specify the password from a shell command.

tlsMMSServerClientCertificatePassword=password

sslServerClientCertificate

Type: string

Specifies the path to the file containing the client's private key, certificate, and optional intermediate certificates in PEM format. The MongoDB Agent uses the client certificate when connecting to Ops Manager over TLS if Ops Manager requires client certificates, such as when Ops Manager runs with Client Certificate Mode set to Required for Agents Only or Required for All Requests.

Tip

See also:

• See Client Certificate Mode in Ops Manager Configuration Settings for how to specify this setting in the Ops Manager Application.

• See Configure MongoDB Agent to Use TLS to enable TLS connections for the MongoDB Agent.

sslServerClientCertificate=/path/to/client.pem

sslServerClientCertificatePassword

Specifies the password needed to decrypt the private key in the sslServerClientCertificate file. This setting is required when the client certificate PEM file is encrypted.

sslServerClientCertificatePassword=password

sslRequireValidMMSBackupServerCertificate

Specifies if the MongoDB Agent should validate TLS certificates from Ops Manager.

Warning

Setting this option to false disables certificate verification and makes connections between the MongoDB Agent and Ops Manager susceptible to man-in-the-middle attacks. Setting this option to false is only recommended for testing purposes.

sslRequireValidMMSBackupServerCertificate=true

Push Live Migration Settings

agentFeatureCloudMigrationEnabled

Type: boolean

Optional.

Specifies whether the MongoDB Agent on the migration host is configured to run the Live Migration process from a source Ops Manager deployment to a target cluster in Atlas.

This option defaults to false, which prevents using the MongoDB Agent on this host for Live Migration to Atlas.

To enable the Live Migration process, provision a migration host and set agentFeatureCloudMigrationEnabled to true.

cloudMigrationOplogPath

Type: string

Optional.

Path to the oplog files. If specified, this setting buffers the initial sync oplog window to disk. Provision enough storage in the specified directory for the oplog buffering.

Externally Sourced Configuration Settings

enableLocalConfigurationServer

Type: boolean

Specifies whether the MongoDB Agent stores MongoDB process configuration files on disk or cached in memory.

This option defaults to false, which stores the configuration files on disk. Setting this option to true caches the configuration in memory.

If you set this option to true, the MongoDB Agent doesn't write the mmsConfigBackup file.

Don't set this option to true if your MongoDB databases are running FCV 4.2 or earlier.

Warning

Setting this option to true impacts the availability of your deployment.

When this feature is enabled, the MongoDB Agent doesn't store the MongoDB process configuration on disk. 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. If a MongoDB process crashes while the MongoDB Agent isn't running, then the MongoDB Agent can't restart the process.

enableLocalConfigurationServer=false

Tip

See also:

Configure How the MongoDB Agent Manages Config Files and Passwords

keepUnusedMongodbVersions

Type: boolean

Flag that indicates whether the MongoDB Agent retains unused MongoDB version binaries that it downloads. By default, keepUnusedMongodbVersions is false.

keepUnusedMongodbVersions=false

localConfigurationServerPort

Type: integer

Specifies the port to serve the MongoDB process configuration to when using the local configuration server. To set this option, enableLocalConfigurationServer must be true.

If unspecified, the MongoDB Agent chooses an available port automatically.

localConfigurationServerPort=20128

mmsApiKeyExec

Type: string

Specifies a shell command to call the Ops Manager agent API key of your Ops Manager project.

mmsApiKeyExec=echo $myKey

sslMMSServerClientCertificatePasswordExec

Type: string

Important

Deprecated. Use tlsMMSServerClientCertificatePasswordExec instead.

tlsMMSServerClientCertificatePasswordExec

Type: string

Specifies a shell command to call the password needed to decrypt the private key in the MMSServerClientCertificate file. Either this setting or tlsMMSServerClientCertificatePassword is required when the client certificate PEM file is encrypted.

tlsMMSServerClientCertificatePasswordExec=python /path/to/PEMPassword.py

MongoDB Kerberos Settings

Specify these settings if Automation authenticates to hosts using Kerberos. To configure Kerberos, see Configure the MongoDB Agent for Kerberos.

krb5ConfigLocation

Type: string

Specifies an absolute path to an non-system-standard location for the Kerberos configuration file.

krb5ConfigLocation=/path/to/krb_custom.conf

Note

Ops Manager creates a Kerberos Credential (Ticket) Cache for each agent automatically when Kerberos is enabled. If you want to override the location of the Kerberos Credential Cache, you must set the KRB5CCNAME environment variable to the desired file name and path before running the agent.

backupAgentKrb5CCName

Type string

Specifies the KRB5CC environment variable that the MongoDB Agent sets for the Backup process. Used only to authenticate the Backup to your MongoDB deployment when the MongoDB Agent starts the Backup function.

backupAgentKrb5CCName=/path/to/credentials_cache_file

monitoringAgentKrb5CCName

Type string

Specifies the KRB5CC environment variable that the MongoDB Agent sets for the Monitoring function. Used only to authenticate Monitoring to your MongoDB deployment when the MongoDB Agent starts the Monitoring function.

monitoringAgentKrb5CCName=/path/to/credentials_cache_file

Log Settings

1. In the navigation, click Deployment.

2. Click the Agents tab.

3. Click Downloads & Settings.

4. In the Agent Log Settings section, click next to Monitoring Log Settings.

5. Edit the Monitoring log settings:

   Setting	Default Value	Console Suggested Value
   Linux Log File Path	/var/log/mongodb-mms-automation/monitoring-agent.log
   Windows Log File Path	%SystemDrive%\MMSAutomation\log\mongodb-mms-automation\monitoring-agent.log
   Rotate Logs	YES
   Size Threshold (MB)	1000
   Time Threshold (Hours)	24
   Max Uncompressed Files		5
   Max Percent of Disk		2
   Total Number of Log Files	0

6. Click Save.

Custom Settings

1. In the navigation, click Deployment.

2. Click the Agents tab.

3. Click Downloads & Settings.

4. In the Custom Configuration section, next to Edit Custom Configurations, click .

5. Enter the Monitoring configuration setting and value.

6. Click Save and Close.

You can configure the following Monitoring settings:

Log Settings

1. In the navigation, click Deployment.

2. Click the Agents tab.

3. Click Downloads & Settings.

4. In the Agent Log Settings section, click next to Backup Log Settings.

5. Edit the Backup log settings:

   Setting	Default Value	Console Suggested Value
   Linux Log File Path	/var/log/mongodb-mms-automation/backup-agent.log
   Windows Log File Path	%SystemDrive%\MMSAutomation\log\mongodb-mms-automation\backup-agent.log
   Rotate Logs	YES
   Size Threshold (MB)	1000
   Time Threshold (Hours)	24
   Max Uncompressed Files		5
   Max Percent of Disk		2
   Total Number of Log Files	0

6. Click Save.

Custom Settings

1. In the navigation, click Deployment.

2. Click the Agents tab.

3. Click Downloads & Settings.

4. In the Custom Configuration section, next to Edit Custom Configurations, click .

5. Enter a Backup configuration setting and value.

6. Click Save and Close.

You can configure the following Backup settings: