Troubleshooting

Last modified on August 09, 2022

You can create troubleshooting bundles for SwaggerHub technical support to assess product health and help with problems. Support bundles contain logs and configuration files that you can examine before downloading and sending to Support. The Admin Console also has a configurable redaction mechanism to remove sensitive information such as passwords, tokens, or PII (Personally Identifiable Information) from the logs in the bundle.

Support bundles

Click the image to enlarge it.

Create a support bundle

  1. Log in to the Admin Console.

  2. Switch to the Troubleshoot tab.

  3. Click Generate a support bundle.

  4. Click Analyze SwaggerHub for support.

  5. Wait until the bundle is created. It may take a few minutes.

  6. If desired, examine the new bundle on the Support bundles analysis screen: overview, files, redactions. If any redaction is required beyond what is shown, contact support for assistance with configuring redactions.

  7. Click Download bundle to download the bundle as a .tar.gz archive.

  8. Send the file to SmartBear Support.

At any time, you can review and download your existing bundles from the Troubleshoot tab of the Admin Console.

See Also

SwaggerHub On-Premise 2.x (Kubernetes) Administrator Guide

Highlight search results