mprobe

mprobe is a diagnostic probe for MongoDB. It enables reading and visualizing the Full Time Diagnostic Data Capture (FTDC) from the MongoDB data files. This project is currently in progress: the diagnostics API is ready, but it may still change; the visualization tool is still very much in progress.

The project consists of the following crates:

• diagnostics
• vis
• cli

Installation

You can install the mprobe on your machine using cargo:

cargo install mprobe

Usage

Fetch the diagnostic metrics

For fetching the diagnostic metrics from the MongoDB Atlas, you can use the fetch command as follows:

mprobe fetch \
    -p <MongoDB Atlas project ID> \
    -k <API key> \
    -s <API secret> \
    -t <resource type (e.g. cluster, replica-set, process)> \
    -n <resource name (e.g. for a replica-set, use: test-123agc-shard-0)> \
    -f [ path where the FTDC will be stored ] \
    -r [ start timestamp ] \
    -o [ end timestamp ]

Visualize the diagnostic metrics

In order to visualize the downloaded diagnostic metrics, you can use the view command as follows:

mprobe view \
    -p <path to the FTDC directory> \
    -n <node name> \
    -s [ start timestamp ] \
    -e [ end timestamp ]

This command will generate an HTML report that includes all the diagnostic metrics of the specified node in a given time window. All the data is stored in the vis directory relative to the current working directory, unless otherwise specified via the -o option.

To start exploring the metrics, open the ./vis/index.html page in the browser.

Help

If you need help with one of the commands or simply would like to see what other options are available, you can use the help command:

mprobe help

To see the options of a specific command, use the following instruction:

mprobe <command> --help

License

mprobe project is licensed under MIT license.