Ceph Support Data Collection. V16

Solution Verified - Updated -

Environment

  • Red Hat Ceph Storage (RHCS) 4+
  • Openshift Data Foundations 4

Issue

  • Sos report does not contain ceph commands.
  • Important sos collected ceph files are cut short.
  • Full sos report is not needed or is too big.
  • Ceph details are needed from an ODF environment and MustGathers are too big or have issues.

Resolution

With the script in this KCS (Please download from the bottom of the page) a set of commonly needed ceph command output is collected. A compressed file is created which should be uploaded to the case.

Pleasese note that this is not to be treated as a Red Hat official binary / software, and feel free to go through the source code to look for what's happening behind the scenes.

Executing the ceph-support-collector

Standalone Ceph

In standalone Ceph the script needs to run on a node where you can execute ceph commands like ceph status (Usually the admin node or a MGR / MON node). If you need sudo to run the script use the --sudo parameter.

ODF

Run the script from a node where you can execute the oc command directly. Use the --odf parameter. The oc command needs to be able to communicate with the OCP cluster and must be in the path (Can be checked with which oc). By default it uses the rook ceph operator pod. If we have issues using the rook operator pod we can install the ODF Toolbox and use --odf --odf-use-toolbox parameters instead.

Usage

Use the --help parameter to check for available command line options.

By default this script collects:

  • Necessary ceph command outputs
  • Cluster, Audit, Cephadm and Config logs
  • Current runtime configuration for all core ceph daemons
  • RGW configurations.
  • Crash details.
  • MON Sessions.

You can exclude some of the data with the following parameters:

  • --no-logs Do not collect any logs (see --help for more finegrained log exclusions).
  • --no-config Do not collect the current running configuration of ceph daemons.
  • --no-rgw-data Do not collect RGW related details.

Root Cause

You can use this script when instructed from Red Hat Support to collect data. It is mostly used when sos reports do not contain ceph related details or sos reports would take much to long to be generated.

Attachments

This solution is part of Red Hat’s fast-track publication program, providing a huge library of solutions that Red Hat engineers have created while supporting our customers. To give you the knowledge you need the instant it becomes available, these articles may be presented in a raw and unedited form.

Comments