Support Bundles

As the system administrator, you can generate a support bundle for Control Hub. A support bundle is a ZIP file that includes the Control Hub log file, environment and configuration information, organization information, and other details to help troubleshoot issues. You upload the generated file to a StreamSets Support ticket, and the Support team can use the information to help resolve the ticket.

When generating the support bundle, Control Hub by default automatically redacts sensitive information entered in configuration files - including URLs, usernames, and passwords. Sensitive information is replaced with the text REDACTED_<hashed_value>, where <hashed_value> is the salted-hashed output of the SHA-256 algorithm.

Generating a Support Bundle

Only users with the System Administrator role can generate support bundles.

After you generate a support bundle, you download the bundle and then upload it to a StreamSets Support ticket.

  1. Click the Help icon, and then click Generate Support Bundle.
  2. Optionally, configure the following properties.

    In most situations, you can use the default values.

    Property Description
    Field Trim Threshold Number of Characters When configuration values include more characters than this threshold, the value is stored in a separate support bundle file. The main Control Hub configuration file refers to this external file for the property value.

    Default is 64.
    Max Log File Size Bytes Maximum size in bytes of the Control Hub log file to include in the support bundle.

    The support bundle includes the most recent log messages until the compressed log file reaches this maximum size.

    Default is 268,453,456 bytes.
    Redact Sensitive Fields Redacts sensitive information entered in configuration files - including URLs, usernames, and passwords.

    By default, sensitive fields are redacted.
  3. Click Generate.

    Control Hub generates the support bundle and saves it to a ZIP file in your default downloads directory.

    You can manually upload the file to a StreamSets Support ticket.