mongo-x-ray-gmd
getMongoData analysis plugin for x-ray.
Install
pip install mongo-x-ray mongo-x-ray-hc mongo-x-ray-gmd
Usage
x-ray gmd /path/to/getMongoData-output.json
x-ray gmd /path/to/getMongoData-output.json -f html -o /path/to/output/
Compatibility
Supports MongoDB 5.0 and above on all topologies:
| Replica Set | Sharded Cluster | Standalone |
|---|---|---|
| ✅ | ✅ | ✅ |
Parameters
x-ray gmd [-h] [-s CHECKSET] [-o OUTPUT] [-f {markdown,html,pdf}] [--no-browser]
gmd_file
| Argument | Description | Default |
|---|---|---|
gmd_file |
Path to the getMongoData output JSON file. | required |
-s, --checkset |
Checkset to run. | default |
-o, --output |
Output folder path. | output/ |
-f, --format |
Output format: markdown, html or pdf (PDF also keeps Markdown and HTML). |
html |
--no-browser |
Do not open the generated report in the browser. | false |
Analysis Items
| Item | Purpose |
|---|---|
SummaryItem |
Overall summary of the getMongoData output. |
BuildInfoItem |
Build information (reuses the healthcheck build info parser and version EOL rule). |
CollInfoItem |
Collection statistics: sizes and fragmentation. |
DBItem |
Database-level information. |
HostInfoItem |
Host filesystem type, NUMA settings and host properties. |
IndexInfoItem |
Index information. |
RSInfoItem |
Replica set topology, oplog window and status. |
SecurityItem |
Security posture. |
ServerStatusItem |
Cache, connections and query targeting status. |
SHInfoItem |
Sharding architecture and shard details. |
Development
Requires Python 3.10+, MongoDB 5.0 or later, the mongo-x-ray core and the mongo-x-ray-hc plugin (gmd reuses its parsers and rules).
make unit-test # run the unit tests
make lint # ruff check + ruff format --check
make minify # minify templates
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mongo_x_ray_gmd-2.0.0.tar.gz
(27.9 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mongo_x_ray_gmd-2.0.0.tar.gz.
File metadata
- Download URL: mongo_x_ray_gmd-2.0.0.tar.gz
- Upload date:
- Size: 27.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d61f323c58f6d7065d0a7c7062471320415402bf5bd2628bf6d205dccc1fb6c0
|
|
| MD5 |
7db1ffae09131e39594d03c1001a412f
|
|
| BLAKE2b-256 |
2938bd2e63eb0eddc5a4fadb1dd012ddafc70c189b4535e38a7c50ae8df4b928
|
Provenance
The following attestation bundles were made for mongo_x_ray_gmd-2.0.0.tar.gz:
Publisher:
publish-pypi.yml on zhangyaoxing/mongo-x-ray-gmd
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mongo_x_ray_gmd-2.0.0.tar.gz -
Subject digest:
d61f323c58f6d7065d0a7c7062471320415402bf5bd2628bf6d205dccc1fb6c0 - Sigstore transparency entry: 2668243867
- Sigstore integration time:
-
Permalink:
zhangyaoxing/mongo-x-ray-gmd@6144bbf6ba23bd7e80ccc0eda492e4732bdd14f8 -
Branch / Tag:
refs/tags/v2.0.0 - Owner: https://github.com/zhangyaoxing
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@6144bbf6ba23bd7e80ccc0eda492e4732bdd14f8 -
Trigger Event:
release
-
Statement type:
File details
Details for the file mongo_x_ray_gmd-2.0.0-py3-none-any.whl.
File metadata
- Download URL: mongo_x_ray_gmd-2.0.0-py3-none-any.whl
- Upload date:
- Size: 41.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9bdee42bcc1f4dd58bee83d80c3862a4d020612aa2f70253b19e817ee0632c5d
|
|
| MD5 |
87496e0a21938f67da6d5b0834546a24
|
|
| BLAKE2b-256 |
a43f30ea13f7535a7602dcab434d078d7a3b970f933ac50433b604c61468312a
|
Provenance
The following attestation bundles were made for mongo_x_ray_gmd-2.0.0-py3-none-any.whl:
Publisher:
publish-pypi.yml on zhangyaoxing/mongo-x-ray-gmd
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mongo_x_ray_gmd-2.0.0-py3-none-any.whl -
Subject digest:
9bdee42bcc1f4dd58bee83d80c3862a4d020612aa2f70253b19e817ee0632c5d - Sigstore transparency entry: 2668244168
- Sigstore integration time:
-
Permalink:
zhangyaoxing/mongo-x-ray-gmd@6144bbf6ba23bd7e80ccc0eda492e4732bdd14f8 -
Branch / Tag:
refs/tags/v2.0.0 - Owner: https://github.com/zhangyaoxing
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@6144bbf6ba23bd7e80ccc0eda492e4732bdd14f8 -
Trigger Event:
release
-
Statement type:
