-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
snmp.txt
222 lines (135 loc) · 5.74 KB
/
snmp.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
================================
Use MongoDB with SNMP Monitoring
================================
.. default-domain:: mongodb
.. versionadded:: 2.2
.. admonition:: Subscriber Only Feature
This feature is only available in the Subscriber Edition of
MongoDB.
This document outlines the use and operation of MongoDB's SNMP
extension, which is is only available in the `MongoDB Subscriber Edition
<http://www.mongodb.com/mongodb-subscriber-edition-download>`_.
Prerequisites
-------------
Install MongoDB Subscriber Edition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The MongoDB Subscriber Edition, is available on four platforms. For
more information, see `MongoDB Subscriber Edition
<http://www.mongodb.com/mongodb-subscriber-edition-download>`_.
Included Files
~~~~~~~~~~~~~~
The Subscriber Edition packages contain the following files:
- ``MONGO-MIB.txt``:
The ``MIB`` file that describes the data (i.e. schema) for MongoDB's
SNMP output
- ``mongod.conf``:
The SNMP configuration file for reading the SNMP output of
MongoDB. The SNMP configures the community names, permissions,
access controls, etc.
Required Packages
~~~~~~~~~~~~~~~~~
To use SNMP, you must install several prerequisites. The names of the
packages vary by distribution and are as follows:
- Ubuntu 11.04 requires ``libssl0.9.8``, ``snmp-mibs-downloader``,
``snmp``, and ``snmpd``. Issue a command such as the
following to install these packages:
.. code-block:: sh
sudo apt-get install libssl0.9.8 snmp snmpd snmp-mibs-downloader
- Red Hat Enterprise Linux 6.x series and Amazon Linux AMI require
``libssl``, ``net-snmp``, ``net-snmp-libs``, and ``net-snmp-utils``.
Issue a command such as the following to install these packages:
.. code-block:: sh
sudo yum install libssl net-snmp net-snmp-libs net-snmp-utils
- SUSE Enterprise Linux requires ``libopenssl0_9_8``, ``libsnmp15``,
``slessp1-libsnmp15``, and ``snmp-mibs``. Issue a command such as the
following to install these packages:
.. code-block:: sh
sudo zypper install libopenssl0_9_8 libsnmp15 slessp1-libsnmp15 snmp-mibs
Configure SNMP
--------------
Install MIB Configuration Files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Ensure that the MIB directory, at ``/usr/share/snmp/mibs`` exists. If
not, issue the following command:
.. code-block:: sh
sudo mkdir -p /usr/share/snmp/mibs
Use the following command to create a symbolic link:
.. code-block:: sh
sudo ln -s [/path/to/mongodb/distribution/]MONGO-MIB.txt /usr/share/snmp/mibs/
Replace ``[/path/to/mongodb/distribution/]`` with the path to your
``MONGO-MIB.txt`` configuration file.
Copy the ``mongod.conf`` file into the ``/etc/snmp`` directory
with the following command:
.. code-block:: sh
cp mongod.conf /etc/snmp/mongod.conf
Start Up
~~~~~~~~
You can control the Subscriber Edition of MongoDB using default or
custom or control scripts, just as you can any other :binary:`~bin.mongod`:
Use the following command to view all SNMP options available in your
MongoDB:
.. code-block:: sh
mongod --help | grep snmp
The above command should return the following output:
.. code-block:: sh
Module snmp options:
--snmp-subagent run snmp subagent
--snmp-master run snmp as master
Ensure that the following directories exist:
- ``/data/db/`` (This is the path where MongoDB stores the data files.)
- ``/var/log/mongodb/`` (This is the path where MongoDB writes the log
output.)
If they do not, issue the following command:
.. code-block:: sh
mkdir -p /var/log/mongodb/ /data/db/
Start the :binary:`~bin.mongod` instance with the following command:
.. code-block:: sh
mongod --snmp-master --port 3001 --fork --dbpath /data/db/ --logpath /var/log/mongodb/1.log
Optionally, you can set these options in a :doc:`configuration file
</reference/configuration-options>`.
To check if :binary:`~bin.mongod` is running with SNMP support, issue the
following command:
.. code-block:: sh
ps -ef | grep 'mongod --snmp'
The command should return output that includes the following
line. This indicates that the proper :binary:`~bin.mongod` instance is running:
.. code-block:: sh
systemuser 31415 10260 0 Jul13 pts/16 00:00:00 mongod --snmp-master --port 3001 # [...]
Test SNMP
~~~~~~~~~
Check for the snmp agent process listening on port ``1161`` with the
following command:
.. code-block:: sh
sudo lsof -i :1161
which return the following output:
.. code-block:: sh
COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
mongod 9238 sysadmin 10u IPv4 96469 0t0 UDP localhost:health-polling
Similarly, this command:
.. code-block:: sh
netstat -an | grep 1161
should return the following output:
.. code-block:: none
udp 0 0 127.0.0.1:1161 0.0.0.0:*
Run ``snmpwalk`` Locally
~~~~~~~~~~~~~~~~~~~~~~~~
``snmpwalk`` provides tools for retrieving and parsing the SNMP data
according to the MIB. If you installed all of the required packages
above, your system will have ``snmpwalk``.
Issue the following command to collect data from :binary:`~bin.mongod` using
SNMP:
.. code-block:: sh
snmpwalk -m MONGO-MIB -v 2c -c mongodb 127.0.0.1:1161 1.3.6.1.4.1.37601
You may also choose to specify the path to the MIB file:
.. code-block:: sh
snmpwalk -m /usr/share/snmp/mibs/MONGO-MIB -v 2c -c mongodb 127.0.0.1:1161 1.3.6.1.4.1.37601
Use this command *only* to ensure that you can retrieve and validate
SNMP data from MongoDB.
Troubleshooting
---------------
Always check the logs for errors if something does not run as expected,
see the log at ``/var/log/mongodb/1.log``. The presence of the following
line indicates that the :binary:`~bin.mongod` cannot read the
``/etc/snmp/mongod.conf`` file:
.. code-block:: sh
[SNMPAgent] warning: error starting SNMPAgent as master err:1