Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version next

D toc

When a job succeeds or fails, you can optionally download the log files associated with the job. Optionally, this download bundle can include configuration files and service logs to assist in debugging job issues. 

Tip

Tip: This feature is recommended. The optional support bundle includes files that

D s support
is likely to require during the support process. See below details related to security.

Security:

  • Optionally, you can enable the application of encryption to sensitive data in the configuration files. See Enable encryption below.
  • You can configure the specific files that you wish to include or exclude.

Enable

This feature is enabled by default. 

Steps:


  1. D s config
  2. Locate the following parameter and set it to true:

    Code Block
    "supportBundle.enabled": true,
  3. Save your changes and restart the platform.
Info

NOTE: Log files that are configured for JSON output format cannot be included in the support bundle. For more information on disabling JSON output in service logs, see Configure Logging for Services.

Disable encryption

By default:

  • For end users, encryption is enabled.
  • For admin users, encryption is always disabled.

When encryption is enabled:

  • Administrators still download a clear-text version of the support bundle.
  • End-users can download an encrypted version of the support bundle. This encrypted version can be delivered to 
    D s support
     to assist in debugging of issues.

As needed, you can insert the public key to apply to the encryption.

Info

NOTE: If you do not have the

D s item
itempublic key
, please contact
D s support
.

Steps:

  1. D s config
  2. Set the following parameters:

    ParameterDescription
    supportBundle.encryption.enabledSet to false to disable encryption of downloaded files for end-users.
    supportBundle.encryption.publicKeyClick Edit to paste in the public key value to use for encryption.
  3. Save your changes and restart the platform.

Disable support bundle UI

By default, 

D s product
 includes two dialogs for downloading logs. To access, select Help menu > Download logs

Info

NOTE: Data in the logs downloaded through the admin version is always unencrypted. Data downloaded through the user version is encrypted but can be unencrypted (see below).

 As needed, you can disable one or both of these dialogs:

Steps:

  1. D s config
  2. Locate the following parameters and set one or both of them to false:

    Code Block
    "supportBundle.endUserUI.enabled": true,
    "supportBundle.adminUI.enabled": true,
  3. Save your changes and restart the platform.

Configure Bundle Contents

You can configure the contents of the support bundle using the following parameters.

Steps:

  1. D s config
  2. Set the following sizing parameters:

    ParameterDescription
    supportBundle.files.maxNumberOfArchiveFiles

    Specifies the maximum number of archive files of the primary platform configuration file

    D s triconf
    to include.

    Whenever this configuration file is saved, a new archive version is created.

    supportBundle.files.maxFileSizeInBytes

    Limits the maximum size in bytes of each file in the bundle. Default is 1000000 (about 1MB).

    Info

    NOTE: Files that exceed this maximum size are truncated at the limit. For log files, older entries are lost.

  3. Review and configure the files to include in the bundle. For more information on these files, see Support Bundle Contents.

    ParameterDescription
    supportBundle.files.staticFilesComma-separated list of paths to the static configuration files to include. Paths are relative to topOfTree.
    supportBundle.files.serviceLogs

    Comma-separated list of service log files to include. Paths are relative to the following directory:

    Code Block
    /opt/trifacta/logs

    For more information on these files, see Configure Logging for Services.

    supportBundle.files.confFiles
    Comma-separated list of configuration files to include in the bundle. Paths are relative to the following directory:
    Code Block
    /opt/trifacta/conf

    Some of these files pertain to the web server that serves the

    D s webapp
    . If the
    D s platform
    is connected to a Hadoop-based running environment, Hadoop configuration files can be included as well. See Support Bundle Contents.

  4. Save your changes and restart the platform.

Logging

  • Unable to download logs: See webapp.log.
  • Problems generating the support bundle: If there are issues generating a support bundle, the ZIP file contains an errors.txt file to provide additional information.