- Administration >
- Monitoring for MongoDB >
- Monitor MongoDB Windows with SNMP
Monitor MongoDB Windows with SNMP¶
On this page
Enterprise Feature
SNMP is only available in MongoDB Enterprise.
Overview¶
MongoDB Enterprise can provide database metrics via SNMP, in
support of centralized data collection and aggregation. This procedure
explains the setup and configuration of a mongod.exe
instance
as an SNMP subagent, as well as initializing and testing of SNMP
support with MongoDB Enterprise.
See also
Monitor MongoDB With SNMP on Linux and Troubleshoot SNMP for more information.
Considerations¶
- SNMP support is only available in
mongod.exe
. Other MongoDB tools such asmongos.exe
do not support SNMP. mongod.exe
does not support the use of SNMP traps.
Configuration Files¶
MongoDB Enterprise contains the following configuration files to support SNMP:
MONGOD-MIB.txt
:The management information base (MIB) file that defines MongoDB’s SNMP output.
mongod.conf.subagent
:The configuration file to run
mongod.exe
as the SNMP subagent. This file sets SNMP run-time configuration options, including theAgentX
socket to connect to the SNMP master.mongod.conf.master
:The configuration file to run
mongod.exe
as the SNMP master. This file sets SNMP run-time configuration options.
Procedure¶
Copy configuration files.¶
Use the following sequence of commands to move the SNMP configuration files to the SNMP service configuration directory.
First, create the SNMP configuration directory if needed and then, from the installation directory, copy the configuration files to the SNMP service configuration directory:
The configuration filename is tool-dependent. For example, when
using net-snmp
the configuration file is snmpd.conf
.
Edit the configuration file to ensure that the communication
between the agent (i.e. snmpd
or the master) and sub-agent
(i.e. MongoDB) uses TCP.
Ensure that the agentXAddress
specified in the SNMP
configuration file for MongoDB matches the agentXAddress
in the
SNMP master configuration file.
Start MongoDB.¶
Start mongod.exe
with the snmp-subagent
to send data
to the SNMP master.
Confirm SNMP data retrieval.¶
Use snmpwalk
to collect data from mongod.exe
:
Connect an SNMP client to verify the ability to collect SNMP data from MongoDB.
Install the net-snmp package to access
the snmpwalk
client. net-snmp
provides the snmpwalk
SNMP client.
<port>
refers to the port defined by the SNMP master,
not the primary port
used by mongod.exe
for
client communication.
Optional: Run MongoDB as SNMP Master¶
You can run mongod.exe
with the snmp-master
option for testing purposes. To do this, use the SNMP master
configuration file instead of the subagent configuration file. From
the directory containing the unpacked MongoDB installation files:
Additionally, start mongod.exe
with the snmp-master
option, as in the following: