Gathering diagnostic information

To gather and submit diagnostic information that is specific to App Connect, complete the following steps:

1. From the command line, log in to your Red Hat OpenShift cluster by using the oc login command.
2. Navigate to a temporary directory where you want to store the diagnostic information that the MustGather tool collects.
3. Collect the information by completing one of these steps:
   • To collect diagnostic information (including version information) from all the namespaces where the IBM App Connect Operator is installed, run the following command. The -v True setting provides a version table that lists the operand and Operator versions for all deployed resources (for example, DesignerAuthoring, Dashboard, IntegrationServer, IntegrationRuntime, and Configuration) in all the namespaces.

     oc adm must-gather --image=icr.io/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-c appconnect -v True'"

   • To collect diagnostic information (including version information) from a specific namespace, run the following command:

     oc adm must-gather --image=icr.io/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-c appconnect -v True -n namespaceName'"

     For example, the following command collects information from a namespace named ace:

     oc adm must-gather --image=icr.io/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-c appconnect -v True -n ace'"

   • To collect diagnostic information (including version information) from a specific namespace and a specific pod within that namespace, run the following command:

     oc adm must-gather --image=icr.io/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-c appconnect -v True -n namespaceName -p podName'"

     Tip: You can run the oc get pods command to obtain the list of pods in the namespace.

     For example, the following command collects information from a namespace named ace and an integration runtime pod named quickstart-ir-6f9f88cd99-kp6bf within that namespace:

     oc adm must-gather --image=icr.io/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-c appconnect -v True -n ace -p quickstart-ir-6f9f88cd99-kp6bf'"

   Tip: You can obtain help information about the MustGather tool's parameters by running the following command:

   oc adm must-gather --image=icr.io/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-h'"

   For each namespace where the Operator is installed, the MustGather tool captures App Connect-specific information to an archive file in the temporary directory that you ran the oc adm must-gather command from. This file is saved with the name ACE_Data_Collector_*.tar.gz under the following directory path:

   must-gather.local.uniqueID/icr-io-cpopen-cpfs-must-gather-sha256-uniqueID/CloudpakForIntegration-timestamp/namespaceName/ACE_product_logs/podName/ACE_Data_Collector_*.tar.gz

   For example:

   must-gather.local.7871852174993092609/icr-io-cpopen-cpfs-must-gather-sha256-0b2d1aeda13297b153735ade2caa1c3039bcdf9a371f43e8afa4ddfb9d435075/CloudpakForIntegration-2023-11-01/ace/ACE_product_logs/customerdb-01-ir-6cbd4d575-kl5j8/ACE_Data_Collector_20231030-103111_IS.tar.gz

   The full set of subdirectories under must-gather.local.uniqueID/icr-io-cpopen-cpfs-must-gather-sha256-uniqueID/CloudpakForIntegration-timestamp/namespaceName is as follows:

   ACE_product_logs
   ClusterServiceVersion
   ConfigMaps
   CustomResources
   Deployments
   InstallPlan
   OperandRequests
   Pod-Description
   Pod-Logs
   ReplicaSets
   Routes
   ServiceAccounts
   Services
   Subscriptions

4. Compress the entire contents of the must-gather.local.uniqueID directory to an archive file.
5. Submit the archive file with your support case as described in Contacting IBM Support.

If you are running the IBM App Connect Operator in a Kubernetes environment, you can use a supplied script to collect diagnostic information.

To gather and submit diagnostic information in a Kubernetes environment, complete the following steps:

1. Download the attached must-gather.zip file.

   This ZIP file contains a README.md file and a get-logs.sh script.

   Note: The get-logs.sh script is supported on Linux® and macOS only.
2. Extract the contents of the ZIP file to a directory on your local computer.
3. Follow the instructions in the README.md file to gather and store the required diagnostics to an archive file.
4. Submit the archive file with your support case as described in Contacting IBM Support.