This project aims to create tools for MongoDB analysis and diagnosis. So far 2 modules are built:

• Health check module.
• Log analysis module (Under construction).

Older versions are not tested.

Log analysis requires JSON format logs, which is supported since 4.4.

The tool is tested with Python 3.9.22.

make deps # if it's the first time you build the project
make # equial to `make build` and `make build-lite`

The compiled executable is in the folder ./dist/.

For developers the make deps will be enough to prepare the environment so you can run this tool in the IDE.

You can also build the tool with AI modules for log analysis. For more details refer to: Build with AI Support.

x-ray [-h] [-q] [-c CONFIG] {healthcheck,hc,log}

Besides, you can use environment variables to control some behaviors:

• ENV=development For developing. It will change the following behaviors:
  • Formatted the output JSON for for easier reading.
  • The output will not create a new folder for each run but overwrite the same files.
• LOG_LEVEL: Can be DEBUG, ERROR or INFO (default).

./x-ray healthcheck localhost:27017 # Scan the cluster with default settings.
./x-ray hc localhost:27017 --output ./output/ # Specify output folder.
./x-ray hc localhost:27017 --config ./config.json # Use your own configuration.

x-ray healthcheck [-h] [-s CHECKSET] [-o OUTPUT] [-f {markdown,html}] [uri]

For security reasons you may not want to include credentials in the command. There are 2 options:

• If the URI is not provided, user will be asked to input one.
• If URI is provided but not username/password, user will also be asked to input them.

Refer to the wiki for more details.

• Customize the thresholds
• Database permissions
• Output
• Customize the output

# Full analysis
./x-ray log mongodb.log
# For large logs, analyze a random 10% logs
./x-ray log -r 0.1 mongodb.log

x-ray log [-h] [-s CHECKSET] [-o OUTPUT] [-f {markdown,html}] [log_file]