Reference >
Automation Agent >
Automation Agent Configuration

Automation Agent Configuration¶

On this page

Configuration File
Settings

Configuration File¶

The location of the Automation Agent configuration file depends on your operating system:

RHEL, CentOS, Amazon Linux, and Ubuntu all use a package manager to install the agent. The package manager creates the following agent configuration file:
```
/etc/mongodb-mms/automation-agent.config
```
OS X, Windows, and other Linux systems use either a tar or msi file for the installation. The Automation Agent stores its configuration in the following file:
```
<installation directory>/local.config
```

Settings¶

Ops Manager provides default values for many of the Automation Agent Configuration settings. However, you must set the mmsGroupId and mmsApiKey values.

Connection Settings¶

mmsGroupId¶

Type: string

Required. The ID of your Ops Manager group. You can find it in Ops Manager under the Group Settings page in the Administration tab.

For example:

copy

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf

mmsApiKey¶

Type: string

Required. The Ops Manager agent API key for the group. To retrieve the key from the Ops Manager interface, click the Administration tab, then the Group Settings page.

For example:

copy

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem

mmsBaseUrl¶

Type: string

The URL of the Ops Manager Web Server.

Set this to the URL of your Ops Manager HTTP Service. For example:

copy

mmsBaseUrl=http://example.com:8080

logFile¶

Type: string

The path to which Ops Manager should write the automation agent’s log. By default, the path is /var/log/mongodb-mms-automation/automation-agent.log, but you can choose an alternate location if desired.

For example:

copy

logFile=/var/log/mongodb-mms-automation/automation-agent.log

mmsConfigBackup¶

Type:

The path to the file where the Automation Agent stores a backup copy of the Ops Manager automation configuration, which describes the desired state of the deployment.

For example:

copy

mmsConfigBackup=/var/lib/mongodb-mms-automation/mms-cluster-config-backup.json

Logging Settings¶

logLevel¶

Type: string

The level of logging granularity. You can choose from the following severity levels, from most verbose to least. By default, logLevel is INFO.

DEBUG
ROUTINE
INFO
WARN
ERROR
DOOM

For example:

copy

logLevel=ROUTINE

Each level includes the log items covered by the following levels. For instance, if you choose DEBUG, the Automation Agent logs all messages, including ROUTINE, INFO, WARN, ERROR, and DOOM. By contrast, if you choose DOOM, the Automation Agent only logs DOOM messages.

maxLogFiles¶

Type: integer

The maximum number of rotate log files to retain. By default, maxLogFiles is 10. You can change the value to retain a different number of rotated log files. For example:

copy

maxLogFiles: 15

maxLogFileSize¶

Type: integer

Specifies the maximum size, in bytes, that a log file can be before triggering log rotation. For example:

copy

maxLogFileSize=536870912

HTTP Proxy Settings¶

httpProxy¶

Type: string

To configure the Automation Agent to use an HTTP proxy, specify the URL of the proxy. For example:

copy

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

← Install the Automation Agent on OS X Monitoring Agent →