mc support diag
Themc support diag command generates a health report for an AIStor deployment.
The command generates and uploads the health report to SUBNET for analysis.
Call Home, which can be disabled or enabled at any time.The resulting health report is intended for use by MinIO Engineering through SUBNET and may contain internal or private data points.Exercise caution before sending a health report to a third party or posting the health report in a public forum.
MinIO recommends that you run the health diagnostics when first provisioning the cluster and again at any failure scenario.
Use themc support diag command to trigger the diagnostic test.For clusters registered with SUBNET, the command uploads the results as part of SUBNET Health reports.
For airgapped or firewalled environments, or other environments that prevent direct network access from the deployment, you can save the report locally with the--airgap flag.After saving, you can then upload the results of the test to SUBNET manually.
The report includes information such as:
- System settings, services, and configurations that might impact performance
- TLS certificate status, validity, expiration, and algorithm type information
- CPU core count and information
- Drive count, status, size, and available space
- Information about data-containing partitions
- Cluster size server count
- File system type
- Memory size and type
- OS symmetry and Linux kernel version
- Internode latency
- Tiering configurations
- NTP synchronization
- Available resources
- Replication configuration
- AIStor Server version
The resulting report is stored locally as a markdown-formatted file nameddiag-report-*.md, where* is a string that identifies the particular report.
Generate health data for an AIStor Object Store at aliasmyaistor and upload to SUBNET.
mc support diag myaistorThe command has the following syntax:
mc[GLOBALFLAGS] support diag\ ALIAS\[--airgap]\[--anonymize string]\[--check=<value>]\[--custom-header, -H value]\[--dtrace]\[--input, -i=<value>]\[--limit-download value]\[--limit-upload value]Required
Thealias of the AIStor deployment.
Optional
Use in environments without network access to SUBNET (for example, airgapped, firewalled, or similar configuration).Generates the diagnostic report and saves it to the location where you ran the command.
You must manually upload the report to SUBNET.
For instructions, see themanual upload example.
If the deployment is airgapped, but the local device where you are using theAIStor Client has network access, you do not need to use the--airgap flag.
Valid values arestrict orstandard.If not specified, log uploads use thestandard mode that does not anonymize host names.
To anonymize all data, including host names, pass this parameter with thestrict mode.
mc support diag myaistor --anonymizeSpecify one or more diagnostic checks to run as a comma-separated list.For example:
mc support diag myaistor --check=sys.drive,sys.memThe client stores the report locally and doesnot upload the report to SUBNET.
The following table lists valid values.
| Check | Name | Description |
|---|---|---|
minio.buckets.max | Buckets Maximum | Recommended maximum number of buckets |
minio.cluster.min | Cluster Size Minimum | Recommended minimum cluster size |
minio.license.expiry | License | License is valid |
minio.net.latency | Internode Network Latency | Internode Latency below 25ms |
minio.net.tls.algo | TLS Certs Algo | TLS certificates use an optimal algorithm |
minio.net.tls.status | TLS Status | TLS is enabled |
minio.net.tls.valid | TLS Certs Validity | TLS certificates are valid |
minio.process.args | CLI Args | AIStor CLI arguments are identical across the cluster |
minio.process.rlimit | Process Resource Limit | AIStor has sufficiently large resource Limit |
minio.process.user | Process User | AIStor running as non-root process |
minio.version.consistency | AIStor Consistency | AIStor version is identical across the cluster |
sys.cpu.consistency | CPU Consistency | CPU make, model and count are identical across the cluster |
sys.cpu.cores.min | CPU Cores | Recommended minimum number of CPU cores |
sys.cpu.extensions | CPU Vector Extensions | Performance features available on all CPUs |
sys.cpu.governor | CPU Governor | CPU governor set to performance |
sys.drive.consistency | Drive Consistency | Drives are identical across the cluster |
sys.drive.status | Drive Status | Drives are online |
sys.drive.usage | Drive Usage | Drive usage below 75% |
sys.fs.consistency | File System Consistency | File system is identical on all Drives |
sys.fs.inodes.free | Inodes Free | Sufficient free inodes |
sys.fs.inodes.usage | Inodes Usage | Inodes usage in sync with drive usage |
sys.fs.supported | File System Supported | Recommended file system |
sys.fs.xfs.errors | XFS Errors | No continuous retries on XFS errors |
sys.mem.consistency | Memory Consistency | Memory is identical across the Cluster |
sys.mem.iommu | IOMMU Configuration | Input-Output Memory Management Unit configured correctly |
sys.mem.swap | Swap Memory | Swap memory is not used |
sys.mem.thp | Transparent Huge Pages Configuration | Transparent Huge Pages configured correctly |
sys.net.eth.buffer | Ethernet Ring Buffer | Ethernet RX/TX ring buffer is optimal |
sys.os.config | OS Services | No known performance-impacting OS services or configs |
sys.os.consistency | OS Consistency | Operating systems are identical across the cluster |
sys.os.kernel.min | Kernel Version | Recommended minimum kernel version |
sys.os.kernel.unstable | Kernel Unstable | No unstable Kernel versions found |
sys.os.ntp | NTP | System clocks are synchronized |
Alias -i
Add an additional custom HTTP header to the request inkey:value format.
Add an OpenTelemetry trace to the header.
Alternatively, set theMC_DTRACE environment variable.
Alias -i
Run diagnostics on the specified file.The file must be of the format*.json.gz.
For example:
mc support diag myaistor --input=myobjstore-health.json.gzThe report doesnot automatically upload to SUBNET.
Optional
Limit client-side download rates to no more than a specified rate in KiB/s, MiB/s, or GiB/s.This affects only the download to the local device running the AIStor Client.Valid units include:
Bfor bytesKfor kilobytesMfor megabytesGfor gigabytesTfor terabytesKifor kibibytesMifor mibibytesGifor gibibytesTifor tebibytes
For example, to limit download rates to no more than 1 GiB/s, use the following:
--limit-download 1GIf not specified, AIStor uses an unlimited download rate.
Optional
Limit client-side upload rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s.This affects only the upload from the local device running the AIStor Client.Valid units include:
Bfor bytesKfor kilobytesMfor megabytesGfor gigabytesTfor terabytesKifor kibibytesMifor mibibytesGifor gibibytesTifor tebibytes
For example, to limit upload rates to no more than 1 GiB/s, use the following:
--limit-upload 1GIf not specified, AIStor uses an unlimited upload rate.
This command supports any of theglobal flags.
Generate a diagnostic report for an AIStor Object Store at aliasmyaistor and save it for manual upload to SUBNET:
mc support diag myaistor --airgap- Run the command to generate and save the
.gzipfile of the health diagnostics - Login toSUBNET and select the Deployments section
- Select the deployment for the report
- Select Upload
- Drag and drop the file or browse to the
.gzipfile location to upload it
Generate health data for an AIStor Object Store at aliasmyaistor and anonymize all sensitive data, including host names.
mc support diag myaistor --anonymize strictPerform a diagnostic check on drives and memory for an AIStor Object Store at aliasmyaistor.
mc support diag myaistor --check=sys.drive,sys.memThis command generates a report that includes all data types that begin withsys.drive.* andsys.mem.*.
Perform a diagnostic check on the CPU governance performance and whether the file system is supported only for an object store at aliasmyaistor.
mc support diag myaistor --check=sys.cpu.governor,sys.fs.supportedPerform all available checks on the file atmyaistor-health.json.gz.The file should be in the current local working directory.
mc support diag myaistor --input=myaistor-health.json.gz● CPU Info ... ✔● Disk Info ... ✔● Net Info ... ✔● Os Info ... ✔● Mem Info ... ✔● Process Info ... ✔● Server Config ... ✔● System Errors ... ✔● System Services ... ✔● System Config ... ✔● Admin Info ... ✔********************************************************************************* WARNING!! ** THIS FILE MAY CONTAIN SENSITIVE INFORMATION ABOUT YOUR ENVIRONMENT ** ** PLEASE INSPECT CONTENTS BEFORE SHARING IT ON ANY PUBLIC FORUM ***********************************************************************************mc: AIStor diagnostics report saved to myaistor-health_20231111053323.json.gzThe gzipped output contains the requested health information.