- Install Ops Manager >
- Advanced Configuration Options >
- Enable Application Database Monitoring
Enable Application Database Monitoring¶
On this page
Prerequisites¶
To enable application database monitoring, including dbStats
and database profiling
information, the database account connecting to AppDB must authenticate as a
user with the following minimum role:
Required Role | Database |
---|---|
clusterMonitor |
admin |
- Windows
- Ubuntu/Debian
- RHEL/CentOS/SLES/AMZ
- Linux
Use this procedure to enable monitoring on an application database on x86_64 architecture running Microsoft Windows:
Log in to the Ops Manager Application.¶
Enable Application Database Monitoring.¶
To enable application database monitoring:
- Click the Admin link in the upper-right corner of the Ops Manager console.
- Click Enable from either:
- The banner introducing the monitoring capability or
- The
Enable Monitoring
setting.
Download the MongoDB Agent.¶
- Click View Agent Install Instructions. The Install Agent Instructions modal opens.
- From the Select Your Server’s Operating System menu, select Windows - MSI.
- Click Next. The Install New MongoDB Agent modal opens.
Install the MongoDB Agent.¶
The MongoDB Agent Installation Instructions box displays the following information:
Base URL
Required for binding to a project.
Project ID (Required for binding to a project)
API Key
If you do not have an API Key, click plus icon Generate Key.
Warning
Some or all of these values are required in a later step. Copy these values then store them where you can access them later.
Run the MongoDB Agent Windows Installer.¶
- Interactive
- Unattended
After the
MSI
downloads, double-click:mongodb-mms-automation-agent-<VERSION>.windows_x86_64.msi
Note
The use of
mongodb-mms-automation
in the filename is a legacy artifact and does not mean that the MongoDB Agent is being installed with Automation configured.If a security warning appears, click Run.
At the Configuration/Log Folder step
Provide the directory into which these files are saved.
At the Key Type step, select:
At the Key Type step, select Agent API Key to bind to a specific project.
Enter the appropriate Agent keys.
Note
These keys are provided in the MongoDB Agent Installation Instructions modal described in the previous step.
- Type your
Base URL
into the Base URL field. - Type your Project ID into the Project ID field.
- Type your Agent API Key into the Agent API Key field.
- Type your
At the MongoDB Paths step, specify the Log and Backup directories
At the Windows Firewall Configuration step, click your preferred firewall configuration.
If you click Configure firewall rules allowing access from only the specified |ipaddr| addresses., type the necessary IPv4 addresses into the provided box.
(Conditional) Windows enables Stealth Mode for the Windows Firewall by default. If you have not disabled it on the MongoDB host on which you are installing the MongoDB Agent, disable it now. Stealth Mode significantly degrades the performance and capability of the MongoDB Agent. Click Disable Stealth Mode.
(Conditional) Windows does not enable Disk Performance Counters by default. If you have not enabled Disk Performance Counters for the MongoDB host, click Enable Disk Performance Counters. The MongoDB Agent uses these counters for some of its hardware monitoring activities.
Click Install.
Click Finish once setup is complete.
After the MSI
downloads, you can run an unattended
install from the command line in either the Command Prompt
or PowerShell. To learn more about unattended installs, see
Microsoft’s documentation on
Standard Installer
Command-Line Options
To run the MSI
installer unattended from the command
line, invoke msiexec.exe
with the /q
and /i
flags and a combination of required and optional
parameters:
Parameter | Necessity | Value |
---|---|---|
MMSAPIKEY |
Required | Agent API key of your Ops Manager project. |
MMSBASEURL |
Required | URL of the Ops Manager host. |
MMSGROUPID |
Required | Unique Identifier of your Ops Manager project. |
CONFIGLOGDIR |
Optional | Absolute file path to which Ops Manager should write the MongoDB Agent configuration file. |
LOGFILE |
Optional | Absolute file path to which Ops Manager should write the MongoDB Agent log |
MMSCONFIGBACKUP |
Optional | Absolute file path to the Ops Manager automation configuration backup JSON file. |
Example
To install the MongoDB Agent unattended,
invoke msiexec.exe
with the following options:
Verify that the MongoDB Agent is running.¶
In the Install Agent Instructions modal, wait for each deployment to show Verified in the Install the MongoDB Agent step.
Click Continue.
Enable monitoring of the Backing Databases.¶
In the Set Up Ops Manager Monitoring modal, wait for the agent to show Monitoring as enabled.
Click Continue.
Provide the Connection Details for the Backing Databases.¶
Complete the following fields:
Hostname | Provide the hostname of the host that serves the backing database. |
---|---|
Port | Provide the port of the backing database. |
Enable Authentication | Toggle this to enable authentication. |
Use TLS/SSL | Toggle to enable TLS. |
After Ops Manager displays Deployment found, click Continue.
Confirm the Backing Databases setup.¶
Ops Manager displays the host serving the backing databases and the running agent. Click Continue.
Use this procedure to enable monitoring on an application database on Intel/AMD:
On x86_64 architecture running Debian 8, Debian 9, Ubuntu 18.04, or Ubuntu 20.04:
Log in to the Ops Manager Application.¶
Enable Application Database Monitoring.¶
To enable application database monitoring:
- Click the Admin link in the upper-right corner of the Ops Manager console.
- Click Enable from either:
- The banner introducing the monitoring capability or
- The
Enable Monitoring
setting.
Install the MongoDB Agent.¶
- Click View Agent Install Instructions. The Install Agent Instructions modal opens.
- From the Select Your Server’s Operating System menu, select Debian 8/9/10, Ubuntu 16.X/18.X/20.x - DEB.
- Click Next. The Install New MongoDB Agent modal opens.
Download the latest version of the MongoDB Agent.¶
Note
Starting with this step, follow the MongoDB Agent installation modal and copy the commands provided into the Linux shell.
From a system shell on the host that will run the MongoDB Agent,
issue the following curl
command to download the installer for
Ubuntu 18.04/20.04 or Debian 9/10 for 64-bit x86:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Edit the MongoDB Agent configuration file.¶
In the directory where you installed the MongoDB Agent, open the
automation-agent.config
file in your preferred text editor:
Update the following configuration keys:
Key | Value |
---|---|
mmsGroupId |
ProjectID of your project. |
mmsApiKey |
|
mmsBaseUrl |
URL (hostname and port) of the Ops Manager Application. |
The resulting changes to the automation-agent.config
file should
look like the following:
Optional: Configure the MongoDB Agent to use a proxy server.¶
To configure the MongoDB Agent to connect to Ops Manager via a proxy
server, you must specify the server in the httpProxy
environment variable.
In the directory where you installed the MongoDB Agent, open the
automation-agent.config
file in your preferred text editor.
Add the following configuration key:
Key | Value |
---|---|
httpProxy |
URL (hostname and port) of to your proxy server. |
Prepare the data directory.¶
The data directory stores MongoDB data. For an existing MongoDB
deployment, ensure that the directory is owned by the mongodb
user. If no MongoDB deployment exists, create the directory and set
the owner.
To create a data directory and set the owner as the mongodb
user:
Start the MongoDB Agent.¶
Issue the following command:
Verify that the MongoDB Agent is running.¶
In the Install Agent Instructions modal, wait for each deployment to show Verified in the Install the MongoDB Agent step.
Click Continue.
Enable monitoring of the Backing Databases.¶
In the Set Up Ops Manager Monitoring modal, wait for the agent to show Monitoring as enabled.
Click Continue.
Provide the Connection Details for the Backing Databases.¶
Complete the following fields:
Hostname | Provide the hostname of the host that serves the backing database. |
---|---|
Port | Provide the port of the backing database. |
Enable Authentication | Toggle this to enable authentication. |
Use TLS/SSL | Toggle to enable TLS. |
After Ops Manager displays Deployment found, click Continue.
Confirm the Backing Databases setup.¶
Ops Manager displays the host serving the backing databases and the running agent. Click Continue.
Use this procedure to enable monitoring on an application database:
- Intel/AMD
On x86_64 architecture:
- RHEL/CentOS 6.x, Amazon Linux
- RHEL/CentOS (7.x/8.x), SUSE12/15, Amazon Linux 2
Running RHEL / CentOS 6.x using an
rpm
package:
Log in to the Ops Manager Application.¶
Enable Application Database Monitoring.¶
To enable application database monitoring:
- Click the Admin link in the upper-right corner of the Ops Manager console.
- Click Enable from either:
- The banner introducing the monitoring capability or
- The
Enable Monitoring
setting.
Install the MongoDB Agent.¶
- Click View Agent Install Instructions. The Install Agent Instructions modal opens.
- From the Select Your Server’s Operating System menu, select Amazon Linux - RPM.
- Click Next. The Install New MongoDB Agent modal opens.
Download the latest version of the MongoDB Agent.¶
Note
Starting with this step, follow the MongoDB Agent installation modal and copy the commands provided into the Linux shell.
From a system shell on the host that will run the MongoDB Agent,
issue the following curl
command to download the installer for
64-bit x86:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Edit the MongoDB Agent configuration file.¶
In the directory where you installed the MongoDB Agent, open the
automation-agent.config
file in your preferred text editor:
Update the following configuration keys:
Key | Value |
---|---|
mmsGroupId |
ProjectID of your project. |
mmsApiKey |
|
mmsBaseUrl |
URL (hostname and port) of the Ops Manager Application. |
The resulting changes to the automation-agent.config
file should
look like the following:
Optional: Configure the MongoDB Agent to use a proxy server.¶
To configure the MongoDB Agent to connect to Ops Manager via a proxy
server, you must specify the server in the httpProxy
environment variable.
In the directory where you installed the MongoDB Agent, open the
automation-agent.config
file in your preferred text editor.
Add the following configuration key:
Key | Value |
---|---|
httpProxy |
URL (hostname and port) of to your proxy server. |
Start the MongoDB Agent.¶
Issue the following command:
Verify that the MongoDB Agent is running.¶
In the Install Agent Instructions modal, wait for each deployment to show Verified in the Install the MongoDB Agent step.
Click Continue.
Enable monitoring of the Backing Databases.¶
In the Set Up Ops Manager Monitoring modal, wait for the agent to show Monitoring as enabled.
Click Continue.
Provide the Connection Details for the Backing Databases.¶
Complete the following fields:
Hostname | Provide the hostname of the host that serves the backing database. |
---|---|
Port | Provide the port of the backing database. |
Enable Authentication | Toggle this to enable authentication. |
Use TLS/SSL | Toggle to enable TLS. |
After Ops Manager displays Deployment found, click Continue.
Confirm the Backing Databases setup.¶
Ops Manager displays the host serving the backing databases and the running agent. Click Continue.
RHEL / CentOS 7.x, SUSE12, SUSE15 or Amazon Linux 2:
- rpm Package
- TAR Archive
Using an rpm
package:
Log in to the Ops Manager Application.¶
Enable Application Database Monitoring.¶
To enable application database monitoring:
- Click the Admin link in the upper-right corner of the Ops Manager console.
- Click Enable from either:
- The banner introducing the monitoring capability or
- The
Enable Monitoring
setting.
Install the MongoDB Agent.¶
- Click View Agent Install Instructions. The Install Agent Instructions modal opens.
- From the Select Your Server’s Operating System menu, select RHEL/CentOS (7.X/8.X), SUSE12, SUSE15, Amazon Linux2 - RPM.
- Click Next. The Install New MongoDB Agent modal opens.
Download the latest version of the MongoDB Agent.¶
Note
Starting with this step, follow the MongoDB Agent installation modal and copy the commands provided into the Linux shell.
From a system shell on the host that will run the MongoDB Agent,
issue the following curl
command to download the installer for
RHEL 7 for 64-bit x86:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Edit the MongoDB Agent configuration file.¶
In the directory where you installed the MongoDB Agent, open the
automation-agent.config
file in your preferred text editor:
Update the following configuration keys:
Key | Value |
---|---|
mmsGroupId |
ProjectID of your project. |
mmsApiKey |
|
mmsBaseUrl |
URL (hostname and port) of the Ops Manager Application. |
The resulting changes to the automation-agent.config
file should
look like the following:
Optional: Configure the MongoDB Agent to use a proxy server.¶
To configure the MongoDB Agent to connect to Ops Manager via a proxy
server, you must specify the server in the httpProxy
environment variable.
In the directory where you installed the MongoDB Agent, open the
automation-agent.config
file in your preferred text editor.
Add the following configuration key:
Key | Value |
---|---|
httpProxy |
URL (hostname and port) of to your proxy server. |
Start the MongoDB Agent.¶
Issue the following command:
Verify that the MongoDB Agent is running.¶
In the Install Agent Instructions modal, wait for each deployment to show Verified in the Install the MongoDB Agent step.
Click Continue.
Enable monitoring of the Backing Databases.¶
In the Set Up Ops Manager Monitoring modal, wait for the agent to show Monitoring as enabled.
Click Continue.
Provide the Connection Details for the Backing Databases.¶
Complete the following fields:
Hostname | Provide the hostname of the host that serves the backing database. |
---|---|
Port | Provide the port of the backing database. |
Enable Authentication | Toggle this to enable authentication. |
Use TLS/SSL | Toggle to enable TLS. |
After Ops Manager displays Deployment found, click Continue.
Confirm the Backing Databases setup.¶
Ops Manager displays the host serving the backing databases and the running agent. Click Continue.
Using a tar
archive:
Log in to the Ops Manager Application.¶
Enable Application Database Monitoring.¶
To enable application database monitoring:
- Click the Admin link in the upper-right corner of the Ops Manager console.
- Click Enable from either:
- The banner introducing the monitoring capability or
- The
Enable Monitoring
setting.
Install the MongoDB Agent.¶
- Click View Agent Install Instructions. The Install Agent Instructions modal opens.
- From the Select Your Server’s Operating System menu, select RHEL/CentOS (7.X/8.X), SUSE12, SUSE15, Amazon Linux 2 - TAR.
- Click Next. The Install New MongoDB Agent modal opens.
Download the latest version of the MongoDB Agent.¶
Note
Starting with this step, follow the MongoDB Agent installation modal and copy the commands provided into the .
From a system shell on the host that will run the MongoDB Agent,
issue the following curl
command to download the installer for
RHEL for 64-bit x86:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the MongoDB Agent.¶
You can install the MongoDB Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the MongoDB Agent, extract the archive:
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the MongoDB Agent binary:
Edit the MongoDB Agent configuration file.¶
In the directory where you installed the MongoDB Agent, open the
local.config
file in your preferred text editor:
Update the following configuration keys:
Key | Value |
---|---|
mmsGroupId |
ProjectID of your project. |
mmsApiKey |
|
mmsBaseUrl |
URL (hostname and port) of the Ops Manager Application. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the MongoDB Agent to use a proxy server.¶
To configure the MongoDB Agent to connect to Ops Manager via a proxy
server, you must specify the server in the httpProxy
environment variable.
In the directory where you installed the MongoDB Agent, open the
local.config
file in your preferred text editor.
Add the following configuration key:
Key | Value |
---|---|
httpProxy |
URL (hostname and port) of to your proxy server. |
Optional: Create the binary, log, and data directories.¶
If you have an existing Monitoring Agent user and do not plan on activating Automation, you only need to create the log directory.
Create the following directories to store files that the MongoDB Agent needs.
Note
The use of mongodb-mms-automation
in the file path is a
legacy artifact and does not mean that the MongoDB Agent is being
installed with Automation configured.
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the MongoDB Agent manages. They include the MongoDB Agent, BI Connector, and MongoDB binaries. |
MongoDB Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the MongoDB Agent creates. |
MongoDB databases | /data |
These are the databases that the MongoDB Agent creates and manages. |
Run the following commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Assign permissions to the system user that runs the MongoDB Agent.¶
Run the following commands:
Start the MongoDB Agent.¶
From the directory in which you installed the MongoDB Agent and as the system user you created in the last step, issue the following command:
Verify that the MongoDB Agent is running.¶
In the Install Agent Instructions modal, wait for each deployment to show Verified in the Install the MongoDB Agent step.
Click Continue.
Enable monitoring of the Backing Databases.¶
In the Set Up Ops Manager Monitoring modal, wait for the agent to show Monitoring as enabled.
Click Continue.
Provide the Connection Details for the Backing Databases.¶
Complete the following fields:
Hostname | Provide the hostname of the host that serves the backing database. |
---|---|
Port | Provide the port of the backing database. |
Enable Authentication | Toggle this to enable authentication. |
Use TLS/SSL | Toggle to enable TLS. |
After Ops Manager displays Deployment found, click Continue.
Confirm the Backing Databases setup.¶
Ops Manager displays the host serving the backing databases and the running agent. Click Continue.
Use this procedure to install enable monitoring on an application
database on Linux systems that do not use deb
or rpm
packages.
Log in to the Ops Manager Application.¶
Enable Application Database Monitoring.¶
To enable application database monitoring:
- Click the Admin link in the upper-right corner of the Ops Manager console.
- Click Enable from either:
- The banner introducing the monitoring capability or
- The
Enable Monitoring
setting.
Install the MongoDB Agent.¶
- Click View Agent Install Instructions. The Install Agent Instructions modal opens.
- From the Select Your Server’s Operating System menu, select Other Linux - TAR.
- Click Next. The Install New MongoDB Agent modal opens.
Download the latest version of the MongoDB Agent.¶
Note
Starting with this step, follow the MongoDB Agent installation modal and copy the commands provided into the Linux shell.
From a system shell on the host that will run the MongoDB Agent,
issue the following curl
command to download the installer for
Generic 64-bit Linux:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the MongoDB Agent.¶
You can install the MongoDB Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the MongoDB Agent, extract the archive:
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the MongoDB Agent binary:
Edit the MongoDB Agent configuration file.¶
In the directory where you installed the MongoDB Agent, open the
local.config
file in your preferred text editor:
Update the following configuration keys:
Key | Value |
---|---|
mmsGroupId |
ProjectID of your project. |
mmsApiKey |
|
mmsBaseUrl |
URL (hostname and port) of the Ops Manager Application. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the MongoDB Agent to use a proxy server.¶
To configure the MongoDB Agent to connect to Ops Manager via a proxy
server, you must specify the server in the httpProxy
environment variable.
In the directory where you installed the MongoDB Agent, open the
local.config
file in your preferred text editor.
Add the following configuration key:
Key | Value |
---|---|
httpProxy |
URL (hostname and port) of to your proxy server. |
Optional: Create the binary, log, and data directories.¶
If you have an existing Monitoring Agent user and do not plan on activating Automation, you only need to create the log directory.
Create the following directories to store files that the MongoDB Agent needs.
Note
The use of mongodb-mms-automation
in the file path is a
legacy artifact and does not mean that the MongoDB Agent is being
installed with Automation configured.
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the MongoDB Agent manages. They include the MongoDB Agent, BI Connector, and MongoDB binaries. |
MongoDB Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the MongoDB Agent creates. |
MongoDB databases | /data |
These are the databases that the MongoDB Agent creates and manages. |
Run the following commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Assign permissions to the system user that runs the MongoDB Agent.¶
Run the following commands:
Start the MongoDB Agent.¶
From the directory in which you installed the MongoDB Agent and as the system user you created in the last step, issue the following command:
Verify that the MongoDB Agent is running.¶
In the Install Agent Instructions modal, wait for each deployment to show Verified in the Install the MongoDB Agent step.
Click Continue.
Enable monitoring of the Backing Databases.¶
In the Set Up Ops Manager Monitoring modal, wait for the agent to show Monitoring as enabled.
Click Continue.
Provide the Connection Details for the Backing Databases.¶
Complete the following fields:
Hostname | Provide the hostname of the host that serves the backing database. |
---|---|
Port | Provide the port of the backing database. |
Enable Authentication | Toggle this to enable authentication. |
Use TLS/SSL | Toggle to enable TLS. |
After Ops Manager displays Deployment found, click Continue.
Confirm the Backing Databases setup.¶
Ops Manager displays the host serving the backing databases and the running agent. Click Continue.
Note
If you can’t view monitoring data, verify that at least one host has monitoring enabled.