mostats 1.0.10

Get the MongoDB database statistic to a local CSV file

Mostats 📊

---

Get the MongoDB database statistic e.g : database name, collection, index size, and collection size to a an excel file.

New version support multiple server instance and getting additional host information, uptime, total number of command, read, getmore, command, insert, summarise the cluster report, and recommended sizing. Host information will be save as "Cluster-info.xlsx" on the same folder

To get host information :

mostats -u "mongodb+srv://username:[e-mail]/" -m True

To get sizing information (specify frequenly access data in percentage -fa) below is the sample of 5% :

mostats -u "mongodb+srv://username:[e-mail]/" -fa 5 -m True

Install

Run this command, please choose pip or pip3

pip3 install mostats
pip install mostats

How to use

Please check on the guide below:

usage: getCluster.py [-h] [-u URL [URL ...]] [-uf URLFILE] [-e EXCELFILE] [-n NAME [NAME ...]] [-nf NAMEFILE] [-m MOREINFO] [-fa FA] [-iops IOPS]

Get the MongoDB database statistic to an excel file

options:
  -h, --help            show this help message and exit
  -u URL [URL ...], --url URL [URL ...]
                        MongoDB cluster URL, default is "mongodb://127.0.0.1". Example:
                        "mongodb+srv://<<username>>:<<password>>@cluster.zqqqy.mongodb.net/?retryWrites=true&w=majority". For multiple server please
                        use the space and "" to seperate
                        example:"mongodb+srv://<<username>>:<<password>>@cluster1.zqqqy.mongodb.net/?retryWrites=true&w=majority"
                        "mongodb+srv://<<username>>:<<password>>@cluster2.zqqqy.mongodb.net/?retryWrites=true&w=majority"
  -uf URLFILE, --urlfile URLFILE
                        Get the MongoDB cluster URL from a file. It will read each line as one MongoDB cluster URL
  -e EXCELFILE, --excelfile EXCELFILE
                        Excel filename, default "Cluster-info.xlsx"
  -n NAME [NAME ...], --name NAME [NAME ...]
                        Cluster name, default value first subdomain example: mongodb+srv://clustername.cl0.mongodb.net will be clustername. For
                        multiple server please use the space and "" to seperate example:"cluster1" "cluster2"
  -nf NAMEFILE, --namefile NAMEFILE
                        Get the cluster name from a file. It will read each line as one cluster name
  -m MOREINFO, --moreinfo MOREINFO
                        Getting the host information, uptime, total number of command, read, and insert
  -fa FA, --fa FA       Frequently access ratio in percent (input number only)
  -iops IOPS, --iops IOPS
                        Expected IOPS

Example

For MongoDB Atlas please leave the cluster name empty

mostats -u "mongodb+srv://username:[e-mail]/?retryWrites=true&w=majority" -c "cluster-info.csv"

Specify custom cluster name for MongoDB Community or Enterprise Edition installation only when MongogDB installed without FQDN

mostats -u "mongodb+srv://username:[e-mail]/?retryWrites=true&w=majority" -n "Cluster1" -c "Custom-file.xlsx"

Getting host information on multiple cluster with custom cluster name. Please leave it empty when getting the data from MongoDB atlas

mostats -u "mongodb+srv://username:[e-mail]/" "mongodb+srv://username:[e-mail]/" -n "Cluster 1" "Cluster 2" -m True

Getting host information and sizing on multiple cluster with custom cluster name. Specify frequently access file by adding parameter -fa. Please leave it empty when getting the data from MongoDB atlas. Below are the sample code for adding frequently access data equal to 5%

mostats -u "mongodb+srv://username:[e-mail]/" "mongodb+srv://username:[e-mail]/" -n "Cluster 1" "Cluster 2" -fa 5 -m True

Getting more than one MongoDB cluster with external file

Mostats can read external files to specify both MongoDB URL and custom name. It will read each line as one MongoDB URL and one cluster name.

Sample mongourl.txt

mongodb+srv://username:[e-mail]/
mongodb+srv://username:[e-mail]/

Sample name.txt

Cluster 1
Cluster 2

Below are the sample script:

mostats -uf "mongourl.txt" -nf "name.txt" -fa 0 -m True