Fix This Page
Navigation
You were redirected from a different version of the documentation. Click here to go back.

Install or Update the Monitoring Agent from Archive

Important

This page describes how to install the agent manually. The easier way to install and run the Monitoring Agent is through Automation, as described in Install or Update the Monitoring Agent through Automation.

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 for your entire deployment. You can run multiple agents to distribute assignments and to provide agent failover.

This tutorial guides 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 network infrastructure 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 8080 if it is using HTTP or 8443 if it is using 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.

Multiple Monitoring Agents

You can run multiple Monitoring Agents to distribute monitoring assignments and provide failover. Ops Manager distributes monitoring assignments among up to 100 running agents. Each agent monitors a different set of MongoDB processes. One Monitoring Agent per group is the primary agent. The primary agent reports the cluster’s status to Ops Manager. As agents are added or shut down, Ops Manager redistributes assignments. If the primary agent fails, Ops Manager assigns another agent to be the primary agent.

Important

To distribute monitoring assignments among multiple Monitoring Agents, you must use Monitoring Agent version 5.0.0 or higher.

If you run more than 100 Monitoring Agents, the additional agents run as standby agents. A standby agent is completely idle, except to log its status as a standby and periodically ask Ops Manager if it should begin monitoring.

For versions of the Monitoring Agent earlier than version 5.0.0, only one agent handles monitoring assignments. All other running agents are standby agents.

To tune the frequency at which standby agents check to see if they should begin monitoring and the interval Ops Manager uses to determine if a standby agent should start monitoring, see Monitoring Agent Session Failover.

If you install multiple Monitoring Agents, ensure that all the Monitoring Agents can reach all the mongod processes in the deployment.

To install multiple agents, simply repeat the installation process.

Collection Interval

If a Monitoring Agent is abruptly stopped, without using an appropriate stop command, Ops Manager will wait 5 minutes before redistributing that agent’s monitoring assignments, which means there can be up to a five-minute delay before another Monitoring Agent begins collecting data and sending pings to Ops Manager. During this interval, the restarted Monitoring Agent will not collect data.

File Descriptors

If you install the Monitoring Agent from a tar.gz archive, you my need to increase the number of open file descriptors allowed for the user running the agent. You can use the ulimit command. See Ulimits in the MongoDB manual.

Prerequisite

Access Control

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.

Install the Monitoring Agent from a tar.gz Archive

You can also access install instructions in Ops Manager, including commands you can copy and paste: click Deployment, then Agents, then Downloads & Settings.

1

Download the latest version of the Monitoring Agent archive.

On a system shell, issue a curl command to download the archive for the agent that works on your platform:

Note

Replace <OpsManagerHost:Port> with the hostname and port of your Ops Manager installation.

For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.rhel7_x86_64.tar.gz

For RHEL / CentOS (7.x) on PowerPC architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.rhel7_ppc641e.tar.gz

For Ubuntu 16.X on PowerPC architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/automation/mongodb-mms-automation-agent-manager_latest_ppc64e1.ubuntu1604.tar.gz

For all other Linux distributions:

curl -OL https://<OpsManagerHost:Port>/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.linux_x86_64.tar.gz
2

Install the Monitoring Agent.

To install the agent that works on your platform, issue the appropriate command to extract the archive:

For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:

tar -xf mongodb-mms-monitoring-agent-latest.rhel7_x86_64.tar.gz

For RHEL / CentOS (7.x) on PowerPC architecture:

tar -xf mongodb-mms-monitoring-agent-latest.rhel7_ppc641e.tar.gz

For Ubuntu 16.X on PowerPC architecture:

tar -xf mongodb-mms-automation-agent-manager_latest_ppc64e1.ubuntu1604.tar.gz

For all other Linux distributions:

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

The Monitoring Agent is installed.

3

Retrieve the agent API key for your Ops Manager group.

To retrieve your group’s agent API key:

  1. Click Settings, then Group Settings. The key appears at the top of the page.
  2. Copy the key.
4

Edit the monitoring-agent.config file to include your agent 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:

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

Start the Monitoring Agent.

Issue the following command:

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

Update the Monitoring Agent from a tar.gz Archive

You can also access update instructions in Ops Manager, including commands you can copy and paste: click Deployment, then Agents, then Downloads & Settings.

1

Stop any currently running Monitoring Agents.

Issue the following command:

pkill -f mongodb-mms-monitoring-agent
2

Download the latest version of the Monitoring Agent archive.

On a system shell, issue a curl command to download the archive for the agent that works on your platform:

Note

Replace <OpsManagerHost:Port> with the hostname and port of your Ops Manager installation.

For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.rhel7_x86_64.tar.gz

For RHEL / CentOS (7.x) on PowerPC architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.rhel7_ppc641e.tar.gz

For Ubuntu 16.X on PowerPC architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/automation/mongodb-mms-automation-agent-manager_latest_ppc64e1.ubuntu1604.tar.gz

For all other Linux distributions:

curl -OL https://<OpsManagerHost:Port>/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.linux_x86_64.tar.gz
3

Install the Monitoring Agent.

To install the agent that works on your platform, issue the appropriate command to extract the archive:

For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:

tar -xf mongodb-mms-monitoring-agent-latest.rhel7_x86_64.tar.gz

For RHEL / CentOS (7.x) on PowerPC architecture:

tar -xf mongodb-mms-monitoring-agent-latest.rhel7_ppc641e.tar.gz

For Ubuntu 16.X on PowerPC architecture:

tar -xf mongodb-mms-automation-agent-manager_latest_ppc64e1.ubuntu1604.tar.gz

For all other Linux distributions:

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

The Monitoring Agent is installed.

4

Retrieve the agent API key for your Ops Manager group.

To retrieve your group’s agent API key:

  1. Click Settings, then Group Settings. The key appears at the top of the page.
  2. Copy the key.
5

Edit the monitoring-agent.config file to include your agent 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:

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

Start the Monitoring Agent.

Issue the following command:

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

Additional Information

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