Support Settings

Dremio Support provides settings that can be used for diagnostic purposes. These settings are enabled (or disabled) via the Dremio UI: Admin > Cluster > Support

Support Access

Support access provides multiple capabilities for communication with Dremio support depending on your role (user or administrator).

Client Tools

Use the Client Tools pane to configure which client application buttons appear on the toolbar for a Dremio project when users view data in a dataset. Users can launch data in a client application by clicking the corresponding toolbar button.

Note:
Users must have Power BI Desktop October 2019 installed to launch the client directly from Dremio by clicking the toolbar button.

To enable a client application, toggle Enabled for the application.

Internal Support Email

The Internal Support Email setting is used to configure an email address for users to contact for assistance with queries or other questions. When configured an “Email Help” button is added to the Help section on the Jobs page which end users can use for assistance. The email sent also includes a link to the query’s profile that assistance is being requested for.

Query Support Bundle

Dremio 12.0.0 provides additional support for YARN-based Dremio deployments. A Dremio administrator must first enable the feature by toggling Download Query Support Bundle on the Support Access page. Dremio users can download the support bundle for any job to which they have access.

Any Dremio user with support access and permission to view a job can download a query support bundle by clicking the Download Query Support Bundle button on the Job Details page:

A Dremio administrator must first enable the feature by toggling Download query support bundle on the Support Access page.

The support bundle includes all logs on the executor node in the following format:

<executor hostname>_application_<container id>_<log type>.log.gz

The bundle includes the following files:

  • server.log.gz
  • server.gc.gz
  • queries.json.gz - Above two files from the coordinator node that planned the query for the day that Dremio ran the query
  • server.out.gz- From the coordinator node that planned the query
  • system_info.json.gz - WLM rules and queues, and support settings
  • query_profile.zip - Full query profile for the query

Important
Hadoop-based deployments using self-signed certificates must either import their certificate into the truststore or disable certificate validation.

To disable certificate validation:

  1. Add provisioning.yarn.nodemanager.certificate-validation.enabled: false to dremio.conf file in the coordinator node.
  2. Restart Dremio.

Support Keys

Support keys are used to configure advanced settings in Dremio and control diagnostic data gathered.

To enable a key:

  1. Navigate to Admin > Cluster > Support > Support Keys.
  2. Enter the support key and click Show
  3. Click to enable or disable the displayed Support Key.
  4. Click Save to save the changes.
Support Key Description
planner.filter.runtime_filter Enable and disable runtime filtering.
planner.verbose_profile Provides more details on planning steps.
ui.upload.allow Allows users to upload files to their home spaces. Enabled by default. See Users, Groups, and Roles for more information.
ui.space.allow-manage Allows users to create and manage spaces. Disabled by default. See Users, Groups, and Roles for more information.
dremio.deltalake.enabled Enables read-only support for the DeltaLake data format. See DeltaLake Data Format for more information, including limitations.
dremio.ui.outside_communication_disabled Disables all exernal communication with Dremio servers. By default Dremio systems send basic information on system health and usage to Dremio in order to better support users and improve product quality. Enabling this support key stops all external communication with Dremio servers.
results.max.age_in_days Sets your cleanup threshold in days. See Job Results Cleanup for more information.
exec.disabled.gandiva-functions List of user-specified Gandiva functions, separated by semicolons, to evaluate with Java rather than Gandiva. Dremio disables all variants of the specified functions with the same name. The following value disables the execution of all variants of two Gandiva functions: castDATE;round. The default value is empty. Enterprise Edition only.
exec.non_partitioned_parquet.enable_runtime_filter Enable and disable runtime filtering for non-partitioned columns. Dremio administrators must also enable planner.filter.runtime_filter to enable runtime filtering for non-partitioned columns.
exec.operator.aggregate.vectorize.use_spilling_operator Enables/disables hash aggregation spilling.
export.tableau.extra-odbc-connection-properties Allows users to set the ODBC connection string when exporting a Dremio dataset to Tableau TDS format when SSL is enabled.
auth.personal-access-token.max_lifetime_days Specifies the expiration period for new personal access tokens. The default value is 90 days. Changes to this value do not affect tokens generated before the update.
token.temporary.expiration.sec Specifies the lifetime in seconds of the temporary authentication tokens sent with the query parameters for operations that redirect users to a resource, such as generating a job profile, downloading a dataset, and downloading a query support bundle. The default value is 300.
export.tableau.export-type Specifies the export type of the .tds file that Dremio generates for Tableau. Valid values are ODBC (default) and NATIVE. ODBC generates a .tds file for connecting to Tableau with ODBC/TDC. NATIVE generates a .tds file for connecting to Tableau with the Tableau SDK Connector
export.bi.hostname You can use this support key to change the default hostname of the SQL endpoint for generating PBIDS/TDS files in corresponding Microsoft Power BI/Tableau. This support key is is available from Dremio version 13.0.0.