- Why is the Support Team asking for a Support Bundle?
- How can a user upload a Support Bundle?
- What data is included in the Support Bundle?
- What if a user doesn't want to provide all pipelines, all logs, all configuration files, or snapshot of the data?
- Are the passwords included in the pipeline json files, log files, or configuration files?
Question:
Why is the Support Team asking for a Support Bundle?
Answer:
Very often during troubleshooting, the issue is not visible right away and the Support Team may need additional information during the process. A Support Bundle includes configuration files and pipelines from the SDC instance, which may help during the investigation. Providing all the information from the beginning (in a Support Bundle) may speed up the investigation.
Question:
How can a user upload a Support Bundle?
Answer:
Support Bundle is a feature introduced in the SDC 2.6.0.0. Only a user with an Admin role can upload a Support Bundle from the SDC UI --> Help icon (in the right upper corner) --> Support Bundle --> Upload.
Question:
What data is included in the Support Bundle?
Answer:
A Support Bundle can include Data Collector logs, environment and configuration information, pipeline JSON files, resource files, and pipeline snapshots.
To double-check the data, which the Support Bundle provides to the Support Team, you can simply download the bundle to your laptop and go through the bundle.
Also, for more information about how the Support Bundle works and what data it includes, you can go to our documentation.
Question:
What if a user doesn't want to provide all pipelines, all logs, all configuration files, or snapshots of the data?
Answer:
The default configuration doesn't allow the Snapshots to be taken and uploaded. From the SDC version 3.0.0.0, when a user wants to upload a Support Bundle, the user can specify what generators will be used. For example, if a user doesn't want to provide all pipelines, the user will uncheck the checkbox for 'Pipelines'.
Question:
Are the passwords included in the pipeline JSON files, log files, or configuration files?
Answer:
By default, the passwords are REDACTED from pipelines, configuration files, or resource files. The Support Team will receive the bundle already with passwords removed.
If you have to follow very strict security policies and you cannot share with the Support Team hostnames or other sensitive information, you can set additional rules to redact the data in the $SDC_CONF/support-bundle-redactor.json file. For example, to customize the generators to redact the names of all machines in the StreamSets domain, add the following rule to the file:
{ "description": "Custom domain names", "trigger": ".streamsets.com", "search": "[a-z_-]+.streamsets.com", "replace": "REDACTED.streamsets.com" }More information, you can find in our documentation.
