mongo-x-ray-hc
Health check analysis plugin for x-ray.
Install
pip install mongo-x-ray mongo-x-ray-hc
Usage
x-ray healthcheck
x-ray hc # alias for healthcheck
x-ray healthcheck -u mongodb://localhost:27017 -f html -o /path/to/output/
Compatibility
Supports MongoDB 5.0 and above on replica sets and sharded clusters. Standalone deployments are not supported.
| Replica Set | Sharded Cluster | Standalone |
|---|---|---|
| ✅ | ✅ | ❌ |
Parameters
x-ray healthcheck [-h] [-u URI] [-s CHECKSET] [-o OUTPUT]
[-f {markdown,html,pdf}] [--no-browser]
| Argument | Description | Default |
|---|---|---|
-u, --uri |
MongoDB connection URI. | HC_URI env var, else mongodb://localhost:47017 |
-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 |
Check Items
| Item | Purpose |
|---|---|
BuildInfoItem |
MongoDB server build information, including a version end-of-life check. |
ClusterItem |
Cluster topology: replica set config/status, sharding overview and oplog window. |
CollInfoItem |
Collection information: sizes, fragmentation and operation latency. |
HostInfoItem |
Host information: filesystem type, NUMA settings and host properties. |
IndexInfoItem |
Index coverage and health. |
SecurityItem |
Security posture (authentication and authorization). |
ServerStatusItem |
Server status: cache, connections, opcounters and query targeting. |
ShardKeyItem |
Shard key selection and data balance. |
Development
Requires Python 3.10+, MongoDB 5.0 or later, and the mongo-x-ray core package.
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_hc-2.0.0.tar.gz
(51.7 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_hc-2.0.0.tar.gz.
File metadata
- Download URL: mongo_x_ray_hc-2.0.0.tar.gz
- Upload date:
- Size: 51.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d83498c9dec79a8dc3e6875c3d64a16eed740c4d67b849c5d3278159a8a64c45
|
|
| MD5 |
6fa9a49b32e137dbed64d95f3d2bdbac
|
|
| BLAKE2b-256 |
6058cd0111c80f38c8e4951be6fa369d7554629e6d61f49aa9c8d96a5c4b2c28
|
Provenance
The following attestation bundles were made for mongo_x_ray_hc-2.0.0.tar.gz:
Publisher:
publish-pypi.yml on zhangyaoxing/mongo-x-ray-hc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mongo_x_ray_hc-2.0.0.tar.gz -
Subject digest:
d83498c9dec79a8dc3e6875c3d64a16eed740c4d67b849c5d3278159a8a64c45 - Sigstore transparency entry: 2668215039
- Sigstore integration time:
-
Permalink:
zhangyaoxing/mongo-x-ray-hc@652adc7832eae6280be64eb1c73acf82e33af24a -
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@652adc7832eae6280be64eb1c73acf82e33af24a -
Trigger Event:
release
-
Statement type:
File details
Details for the file mongo_x_ray_hc-2.0.0-py3-none-any.whl.
File metadata
- Download URL: mongo_x_ray_hc-2.0.0-py3-none-any.whl
- Upload date:
- Size: 102.3 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 |
b8f4206de41985bb3bbfec11fe636ca4235c51a28ec78f94cec1de9239061a9b
|
|
| MD5 |
5768c897f65aa7571aee0341086067f8
|
|
| BLAKE2b-256 |
d42dd746638f86ce71cd00d7be66d043431a154e6566ad00dd31c8524fdd6835
|
Provenance
The following attestation bundles were made for mongo_x_ray_hc-2.0.0-py3-none-any.whl:
Publisher:
publish-pypi.yml on zhangyaoxing/mongo-x-ray-hc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mongo_x_ray_hc-2.0.0-py3-none-any.whl -
Subject digest:
b8f4206de41985bb3bbfec11fe636ca4235c51a28ec78f94cec1de9239061a9b - Sigstore transparency entry: 2668215122
- Sigstore integration time:
-
Permalink:
zhangyaoxing/mongo-x-ray-hc@652adc7832eae6280be64eb1c73acf82e33af24a -
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@652adc7832eae6280be64eb1c73acf82e33af24a -
Trigger Event:
release
-
Statement type:
