Skip to main content Skip to complementary content
Qlik Resources
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal

Generating a support bundle for engine troubleshooting

Use a Remote Engine specific script, talend-re-helper.sh or talend-re-helper.bat, to collect context information about the issues you encountered.

You can then use this information yourself or send it to the Qlik Support team for engine troubleshooting.

Only the information stored under the <RemoteEngineInstallation> folder and its sub-folders is collected. If you have configured your Remote Engine to place some working files outside the <RemoteEngineInstallation> folder, these files cannot be collected.

Only a Remote Engine from v2.10.7 and onwards supports this script.

Procedure

  1. In your command-line terminal, go to the <RemoteEngineInstallation>/scripts folder.
  2. Run talend-re-helper.sh or talend-re-helper.bat.

    Example

    • If you need help information about this script, run it with the help parameter:
      ./talend-re-helper.sh --help
    • If the default SSH password has been changed, you need to provide this password to extract the Karaf dumps. Run this command with the updated password:
      ./talend-re-helper.sh --password=<updated-password>
      For further information about SSH for Remote Engine, see Enabling remote access using SSH (optional).

    You can run this script with your engine either on or off. However, the engine must be running if you need to collect dump files about the engine container state.

Results

This script generates an archive in the current directory with the following folders or files collected from your Remote engine machine:
  • Folders:
    /etc
/TalendJobServersFiles/jobexecutions/logs
/data/log
/data/job
/instances
  • Files:
    /karaf.pid
/version.txt
/system.txt
/TalendJobServersFiles.archiveJobs.csv
/TalendJobServersFiles.repository.csv
/lock.csv
/data.m2.csv
/data.filebuffer.csv
    • This system.txt stores the global information about Java and the system.
    • The CSV files list all the files added to this archive along with the metadata of these files, such as their paths in the Remote Engine machine, their owners and creation times.
  • Zips of dump files about the state of an engine container, such as its environment configuration and memory information. For example, a dump zip of this kind could be dump-2021-10-08_09-35-29.zip.

    If you need to collect the dump files, your engine must be up and running when you run this script.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here