Monitor MongoDB Windows with SNMP

New in version 2.6.

Enterprise Feature

SNMP is only available in MongoDB Enterprise.

Overview

MongoDB Enterprise can provide database metrics via SNMP, insupport of centralized data collection and aggregation. This procedureexplains the setup and configuration of a mongod.exe instanceas an SNMP subagent, as well as initializing and testing of SNMPsupport with MongoDB Enterprise.

See also

Monitor MongoDB With SNMP on Linux andTroubleshoot SNMP for more information.

Considerations

Only mongod.exe instances provide SNMPsupport. mongos.exe and the other MongoDB binaries do notsupport SNMP.

Configuration Files

Changed in version 2.6.

MongoDB Enterprise contains the following configuration files tosupport SNMP:

  • MONGOD-MIB.txt:

The management information base (MIB) file that defines MongoDB’sSNMP output.

  • mongod.conf.subagent:

The configuration file to run mongod.exe as the SNMPsubagent. This file sets SNMP run-time configuration options,including the AgentX socket to connect to the SNMP master.

  • mongod.conf.master:

The configuration file to run mongod.exe as the SNMPmaster. This file sets SNMP run-time configuration options.

Procedure

Copy configuration files.

Use the following sequence of commands to move the SNMPconfiguration files to the SNMP service configuration directory.

First, create the SNMP configuration directory if needed and then, fromthe installation directory, copy the configuration files to the SNMPservice configuration directory:

  1. md C:\snmp\etc\config
  2. copy MONGOD-MIB.txt C:\snmp\etc\config\MONGOD-MIB.txt
  3. copy mongod.conf.subagent C:\snmp\etc\config\mongod.conf

The configuration filename is tool-dependent. For example, whenusing net-snmp the configuration file is snmpd.conf.

Edit the configuration file to ensure that the communicationbetween the agent (i.e. snmpd or the master) and sub-agent(i.e. MongoDB) uses TCP.

Ensure that the agentXAddress specified in the SNMPconfiguration file for MongoDB matches the agentXAddress in theSNMP master configuration file.

Start MongoDB.

Start mongod.exe with the snmp-subagent to send datato the SNMP master.

  1. mongod.exe --snmp-subagent

Confirm SNMP data retrieval.

Use snmpwalk to collect data from mongod.exe:

Connect an SNMP client to verify the ability to collect SNMP datafrom MongoDB.

Install the net-snmp package to accessthe snmpwalk client. net-snmp provides the snmpwalkSNMP client.

  1. snmpwalk -m C:\snmp\etc\config\MONGOD-MIB.txt -v 2c -c mongodb 127.0.0.1:<port> 1.3.6.1.4.1.34601

<port> refers to the port defined by the SNMP master,not the primary port used by mongod.exe forclient communication.

Optional: Run MongoDB as SNMP Master

You can run mongod.exe with the snmp-masteroption for testing purposes. To do this, use the SNMP masterconfiguration file instead of the subagent configuration file. Fromthe directory containing the unpacked MongoDB installation files:

  1. copy mongod.conf.master C:\snmp\etc\config\mongod.conf

Additionally, start mongod.exe with the snmp-masteroption, as in the following:

  1. mongod.exe --snmp-master