Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Install or Update the Monitoring Agent from Archive

On this page

Overview

The Ops Manager Monitoring Agent is a lightweight component that runs within your infrastructure, connects to your MongoDB processes, collects data about the state of your deployment, and then sends the data to Ops Manager, which processes and renders this data. The agent initiates all connections between the agent and Ops Manager, and communications between the agent and Ops Manager are encrypted. A single agent can collect data from multiple MongoDB processes.

This tutorial will guide you through the steps necessary to install or update the Monitoring Agent on your system. You must install the Ops Manager itself before installing the Monitoring Agent.

See Monitoring FAQs for additional information.

Considerations

Connectivity

You must configure the networking rules of your deployment so that:

  • the Monitoring Agent can connect to all mongod and mongos instances that you want to monitor.
  • the Monitoring Agent can connect to Ops Manager on port 443 (i.e. https.)

Ops Manager does not make any outbound connections to the agents or to MongoDB instances. If Exposed DB Host Check is enabled, Ops Manager will attempt to connect to your servers occasionally as part of a vulnerability check.

Ensure all mongod and mongos instances are not accessible to hosts outside your deployment.

Monitoring Agent Redundancy

A single Monitoring Agent is sufficient. However, you can run additional instances of the agent as hot standbys to provide redundancy. If the primary agent fails, a standby agent starts monitoring.

When you run multiple agents, only one Monitoring Agent per group or environment is the primary agent. The primary agent reports the cluster’s status to Ops Manager. The remaining agents are completely idle, except to log their status as standby agents and to periodically ask Ops Manager whether they should become the primary.

mms.monitoring.agent.standbyCollectionFactor configures the frequency at which the standby agents check to see if they have become the primary agent. By default, the standby agents check every 14 seconds. See the mms.monitoring.agent.standbyCollectionFactor reference for details.

Ops Manager promotes a standby agent to primary after not hearing from the current primary for at least the interval specified by mms.monitoring.agent.session.timeoutMillis. The default delay is 90 seconds (90000 milliseconds), which is also the minimum.

You can tune mms.monitoring.agent.standbyCollectionFactor and mms.monitoring.agent.session.timeoutMillis by editing Ops Manager Configuration.

To install additional agents, simply repeat the installation process.

Collection Interval

If you are updating the agent, keep in mind that when the Monitoring Agent restarts, there is a five-minute delay before that agent begins collecting data and sending pings to Ops Manager. If you have multiple agents, this delay permits other agents in your infrastructure to become the primary agent and permits Ops Manager to determine which agent will be primary.

During this interval, the restarted Monitoring Agent will not collect data.

Prerequisites

If your MongoDB deployment enforces access control, you must create a user in MongoDB with the appropriate access. See Configure Monitoring Agent for Access Control.

Procedures

This section includes procedures for installing and updating the Monitoring Agent on a Linux system not listed in the Agent Downloads list on the Agents page in the Settings tab.

Install the Monitoring Agent from a tar.gz Archive

Use this procedure to install the agent on Linux systems:

1

Download the latest version of the Monitoring Agent archive.

With a system shell, issue the following command:

copy 
curl -OL <mmsUri>/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.linux_x86_64.tar.gz
2

Install the Monitoring Agent.

To install the agent, extract the archive by issue the following command:

copy 
tar -xf mongodb-mms-monitoring-agent-latest.linux_x86_64.tar.gz

The Monitoring Agent is installed.

3

Retrieve the Ops Manager API key for your Ops Manager group.

In the Settings tab on the Agents page, click the link for your operating system. Ops Manager will then display a procedure that includes a step to set your Ops Manager API key. The step displays the actual Ops Manager API key used by your Ops Manager group. Copy the key.

4

Edit the monitoring-agent.config file to include your Ops Manager API key.

In the <install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.

5

Optional: Configure the Monitoring Agent to use a proxy server.

To configure the agent to connect to Ops Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/monitoring-agent.config file, set the httpProxy value to the URL of to your proxy server:

copy 
httpProxy="http://proxy.example.com:9000"
6

Start the Monitoring Agent.

Issue the following command:

copy 
nohup ./mongodb-mms-monitoring-agent >> monitoring-agent.log 2>&1 &

Remember, that you only need to run 1 Monitoring Agent for each Ops Manager group. A single Monitoring Agent can collect data from many MongoDB instances.

Update the Monitoring Agent from a tar.gz Archive

Use this procedure to update the agent on Linux systems:

1

Stop any currently running Monitoring Agents.

Issue the following command:

copy 
pkill -f mongodb-mms-monitoring-agent
2

Download the latest version of the Monitoring Agent archive.

With a system shell, issue the following command:

copy 
curl -OL <mmsUri>/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.linux_x86_64.tar.gz
3

Install the Monitoring Agent.

To install the agent, extract the archive by issue the following command:

copy 
tar -xf mongodb-mms-monitoring-agent-latest.linux_x86_64.tar.gz

The Monitoring Agent is installed.

4

Retrieve the Ops Manager API key for your Ops Manager group.

In the Settings tab on the Agents page, click the link for your operating system. Ops Manager will then display a procedure that includes a step to set your Ops Manager API key. The step displays the actual Ops Manager API key used by your Ops Manager group. Copy the key.

5

Edit the monitoring-agent.config file to include your Ops Manager API key.

In the <install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.

6

Optional: Configure the Monitoring Agent to use a proxy server.

To configure the agent to connect to Ops Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/monitoring-agent.config file, set the httpProxy value to the URL of to your proxy server:

copy 
httpProxy="http://proxy.example.com:9000"
7

Start the Monitoring Agent.

Issue the following command:

copy 
nohup ./mongodb-mms-monitoring-agent >> monitoring-agent.log 2>&1 &

Remember, that you only need to run 1 Monitoring Agent for each Ops Manager group. A single Monitoring Agent can collect data from many MongoDB instances.

Additional Information

If you installed the Monitoring Agent from the tar.gz archives, see Rotate Agent Log Files to configure log rotation.

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.