Debug data collection

This topic describes how debug data can be collected by using the spectrum-scale-driver-snap.sh tool.

IBM Spectrum Scale Container Storage Interface driver provides the spectrum-scale-driver-snap.sh tool to collect the debug data. This tool gathers the state of required Kubernetes resources like nodes, pods, service accounts, and so on and collects StatefulSet and DaemonSet logs from all nodes. It collects definition of resources in the given namespace with the label, product=ibm-spectrum-scale-csi. The collected logs are stored in the given output directory.

Download the tool from this location:
https://raw.githubusercontent.com/IBM/ibm-spectrum-scale-csi/v1.0.1/tools/spectrum-scale-driver-snap.sh

Usage of the tool

spectrum-scale-driver-snap.sh [-n namespace] [-o output-dir] [-h]

-n: Debug data for CSI resources under this namespace will be collected. If not specified, default namespace is used. The tool returns error if CSI is not running under the given namespace.
-o: Output directory where debug data will be stored. If not specified, the debug data is stored in current directory.
-h: Prints the usage

The resultant folder contains the following files with debug information:

  • nodes.json
  • ibm-spectrum-scale-csi-k8snodes
  • ibm-spectrum-scale-csi-configmap
  • ibm-spectrum-scale-csi-get-all-by-label
  • ibm-spectrum-scale-csi-describe-all-by-label
  • ibm-spectrum-scale-csi-operator-6d4bd865f6-XXXXX-operator-previous.log
  • ibm-spectrum-scale-csi-operator-6d4bd865f6-XXXXX-ansible-previous.log
  • ibm-spectrum-scale-csi-operator-6d4bd865f6-XXXXX-operator.log
  • ibm-spectrum-scale-csi-operator-6d4bd865f6-XXXXX-ansible.log
  • ibm-spectrum-scale-csi-describe-CSIScaleOperator
  • ibm-spectrum-scale-csi-XXXXX-driver-registrar-previous.log
  • ibm-spectrum-scale-csi-XXXXX-previous.log
  • ibm-spectrum-scale-csi-XXXXX-driver-registrar.log
  • ibm-spectrum-scale-csi-XXXXX.log
  • ibm-spectrum-scale-csi-XXXXX-driver-registrar-previous.log
  • ibm-spectrum-scale-csi-XXXXX-previous.log
  • ibm-spectrum-scale-csi-XXXXX-driver-registrar.log
  • ibm-spectrum-scale-csi-XXXXX.log
  • ibm-spectrum-scale-csi-provisioner.log
  • ibm-spectrum-scale-csi-attacher.log
  • ibm-spectrum-scale-csi-k8snodes
  • ibm-spectrum-scale-csi-configmap
  • ibm-spectrum-scale-csi-get-all-by-label
  • ibm-spectrum-scale-csi-describe-all-by-label
  • ibm-spectrum-scale-csi-attacher.log
  • ibm-spectrum-scale-csi-provisioner.log
  • ibm-spectrum-scale-csi-xxxxx-driver-registrar.log
  • ibm-spectrum-scale-csi-xxxxx.log