Gathering logs

To help IBM Support troubleshoot any issues with your Event Streams instance, use the oc adm must-gather command to capture the must gather logs. The logs are stored in a folder in the current working directory.

Online environments

To gather diagnostic logs in an online environment:

  1. Log in to your Red Hat OpenShift Container Platform as a cluster administrator by using the oc CLI (oc login).

  2. Run the following command to capture the logs:

    oc adm must-gather --image=icr.io/cpopen/ibm-eventstreams-must-gather -- gather -m eventstreams -n <namespace>

To gather system level diagnostics in addition to the Event Streams information:

  1. Log in to your Red Hat OpenShift Container Platform as a cluster administrator by using the oc CLI (oc login).

  2. Run the following command to capture the logs:

    oc adm must-gather --image=icr.io/cpopen/ibm-eventstreams-must-gather -- gather -m system,eventstreams -n <namespace>

These logs are stored in an archive file in a folder in the current working directory. For example, the must-gather archive could be located on the path:

must-gather.local.6409880158745169979/icr-io-cpopen-ibm-eventstreams-must-gather-sha256-23a438c8f46037a72b5378b29decad00e871d11f19834ba75b149326847e7c05/cloudpak-must-gather-20200624100001.tgz

Air-gapped (offline) environments

To gather diagnostic logs in an air-gapped (also referred to as offline or disconnected) environment:

  1. Pull the Event Streams must-gather image as follows:

    docker pull icr.io/cpopen/ibm-eventstreams-must-gather

  2. Tag the image:

    docker image -t icr.io/cpopen/ibm-eventstreams-must-gather <private-registry-image-address:tag>

  3. Push the tagged image to the internal registry of your air-gapped environments:

    docker push <private-registry-image-address:tag>

    Note: Automatic updates to the must-gather image are not supported in an air-gapped environment. Repeat the previous steps frequently to ensure you are gathering logs with the most recent image.

  4. Log in to your Red Hat OpenShift Container Platform as a cluster administrator by using the oc CLI (oc login).

  5. Run the following command to capture the logs:

    oc adm must-gather --image=<image-location-on-internal-registry> -- gather -m system,eventstreams -n <namespace>

After completing successfully, the command will store the logs in an archive file in a folder in the current working directory.