bijiajin / hyperic-mongodb Goto Github PK

This project is a Hyperic HQ plugin for monitoring MongoDB

Source code is available at github.com/ClarityServices/hyperic-mongodb

For screen shots of some of the items that can be monitored, see the Hyperic HQ MongoDB plugin Wiki

Only supports MongoDB running on Unix, Linux and Mac since it uses a bash shell to invoke the mongo shell.

Also made it work on Windows? Please fork and submit a pull request. (Or just email me the plugin-xml and I will post the updated file)

The MongoDB server process (mongod) is auto-discovered.

The following metrics are available:

• All db.serverStatus() metrics
• Replication delay - The number of seconds that a secondary server (replica) is behind the primary server
• Replication oplog time - Maximum time any Secondary servers can fall behind the master before needing a full re-synch
• All server process (mongod) metrics are also available - CPU Utilization, Resident Memory, etc.

For the complete list of Metrics available, please see the HyperForge MongoDB documentation

Messages are optionally reported from mongodb.log and can be filtered by regex include/exclude.

The mongodb config file can be monitored for changes.

None yet. Submit any ideas as issues on github

Mongo shell (mongo) and Bash Shell (bash)

• MongoDB Plugin 2.x tested on Red Hat Enterprise Linux 5 with MongoDB 1.6.5
• MongoDB Plugin 3.x tested on Red Hat Enterprise Linux 7 with MongoDB 2.6 and 3.2.1

Tested with Hyperic HQ version 4.4, 4.5.1 and 5.8.2

Fetch the latest version of the file using something like wget or a browser:

• MongoDB Plugin 2.x for MongoDB Server v1.6-v.2.6

wget --no-check-certificate https://raw.githubusercontent.com/ClarityServices/hyperic-mongodb/master/2.x/mongodb-plugin.xml

• MongoDB Plugin 3.x for all version of MongoDB from v1.6

wget --no-check-certificate https://raw.githubusercontent.com/ClarityServices/hyperic-mongodb/master/3.x/mongodb-plugin.xml

Copy the file mongodb-plugin.xml into the following folder under the server installation

• For Hyperic 4.5.1

hq-plugins

• For Hyperic 4.4

hq-engine/server/default/deploy/hq.ear/hq-plugins

Output similar to the following should appear in the server logfile (logs/server.log)

2011-02-21 13:53:53,972 INFO  [ScannerThread] [org.hyperic.hq.product.server.mbean.ProductPluginDeployer@654] HQ plugin mongodb-plugin.xml undeployed
2011-02-21 13:53:53,995 INFO  [ScannerThread] [org.hyperic.hq.product.server.mbean.ProductPluginDeployer@654] HQ plugin mongodb registered
2011-02-21 13:53:54,001 INFO  [ScannerThread] [org.hyperic.hq.product.server.session.ProductManagerEJBImpl@320] mongodb unknown -- registering
2011-02-21 13:53:54,217 INFO  [ScannerThread] [org.hyperic.hq.product.server.mbean.ProductPluginDeployer@654] HQ plugin mongodb deployed

If the output above does not appear in the log file ensure that the file is in the directory along with several other files ending with -plugin.xml and -plugin.jar

It is not necessary to restart the server, it automatically picks up new plugins.

Copy the file mongodb-plugin.xml into the plugins folder under the client installation. The path should be similar to:

• For Hyperic 4.5.1

hq-plugins

• For Hyperic 4.4

agent/bundles/agent-4.4.0-1509/pdk/plugins/

Restart the agent to pull in the new plugin file

To test any changes prior to deploying

java -jar bundles/agent-4.4.0-1509/pdk/lib/hq-product.jar -Dplugins.include=mongodb -m discover -a metric

To generate updated documentation for the HyperForge Wiki, run the following command:

java -jar bundles/agent-4.4.0-1509/pdk/lib/hq-product.jar -Dplugins.exclude=vsphere -m generate -a metrics-wiki

Then update the page on HyperForge

• Code: git clone git://github.com/ClarityServices/hyperic-mongodb.git
• Home: https://github.com/ClarityServices/hyperic-mongodb
• Bugs: https://github.com/ClarityServices/hyperic-mongodb/issues

Reid Morrison :: [email protected] :: @reidmorrison

Kroniak :: [email protected] :: @kroniak

Copyright 2016 Clarity Services, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.