A collection of scripts to set up MongoDB test environments and parse and visualize MongoDB log files.
HTML Python Other
Latest commit 710c1c7 Dec 13, 2016 @stennie stennie Bump dev version

README.md

mtools

PyPI version PyPi downloads Build Status

mtools is a collection of helper scripts to parse and filter MongoDB log files (mongod, mongos), visualize log files and quickly set up complex MongoDB test environments on a local machine.

mtools box

What's in the box?

The following tools are in the mtools collection:

mlogfilter
slices log files by time, merges log files, filters slow queries, finds table scans, shortens log lines, filters by other atributes, convert to JSON

mloginfo
returns info about log file, like start and end time, version, binary, special sections like restarts, connections, distinct view

mplotqueries
visualize logfiles with different types of plots (requires matplotlib)

mlogvis
creates a self-contained html file that shows an interactive visualization in a web browser (as an alternative to mplotqueries)

mlaunch
a script to quickly spin up local test environments, including replica sets and sharded systems (requires pymongo)

mgenerate
generates structured pseudo-random data based on a template for testing and reproduction

You can find the manual and many usage examples on the mtools wiki pages.

Requirements and Installation Instructions

The mtools collection is written in Python, and most of the tools only make use the standard packages shipped with Python version 2.6.x and 2.7.x, and should run out of the box.

mtools is not currently compatible with Python 3.

Some of the tools have additional dependencies, which are listed under the specific tool's section. See the INSTALL.md file for installation instructions for these modules.

Recent Changes

The current version of mtools is 1.2.3. See CHANGES.md for a list of recent changes from previous versions of mtools.

Contribute to mtools

If you'd like to contribute to mtools, please read the contributor page for instructions.

Disclaimer

This software is not supported by MongoDB, Inc. under any of their commercial support subscriptions or otherwise. Any usage of mtools is at your own risk. Bug reports, feature requests and questions can be posted in the Issues section here on github.