Diagnostic bundle

StorageOS can generate a cluster diagnostic bundle from the GUI or CLI under user request. The bundle packages the information needed for the engineering team to understand the context of your cluster and begin troubleshooting any issues you may be experiencing.

Generate Bundle

CLI

The StorageOS CLI can generate the bundle.

$ storageos get diagnostics

The file generated is in the form of diagnostics-${TIME_STAMP}.gz

GUI

Or you can use the StoregeOS GUI.

  1. Go to section “Cluster”
  2. Press the button “DOWNLOAD DIAGNOSTICS”.

Data collected in the bundle

Most of the data collected in the bundle is regarding the state of the StorageOS cluster, however some other information regarding the infrastructure is also gathered. The information is used to have a clear view of the cluster where StorageOS is running.

The bundle incorporates for each node:

  • StorageOS Daemonset Pod logs
  • lshw
  • dmesg (kernel logs)
  • StorageOS metadata for the ControlPlane and DataPlane

StorageOS metadata collected

  • cluster metadata
  • namespaces metadata
  • nodes metadata
  • volumes metadata
  • capacity stats
  • environment variables
  • health

Privacy

StorageOS can only obtain the bundle if it is downloaded by the user and given to our engineering team, or uploaded for analysis. The data received by StorageOS is private and never leaves nor will leave StorageOS Inc.

The data contained in the cluster diagnostic bundle has the sole purpose of helping customers troubleshoot their issues.