Custom Properties#
General Information about Custom Properties#
Example: 'das.job.health.check=true'
A custom property consists of a name (key) and a value pair, separated by a "=".
List of DAS Properties#
INFO
Set up the custom properties in the '/conf' folder within your Spectrum instance.
- execution related properties: define parameters for a job that Spectrum sends to the cluster, e.g. container memory, split size.
- conductor related properties: define the application behavior, e.g. proxy settings, preview size, thread pool.
Execution Related Properties#
| Name | Default Value | Description |
|---|---|---|
| das.io.compression.codecs.addition | spectrum.dap.common.util.ZipCodec | Additional compression codecs that are added to io.compression.codecs |
| das.error.log.max-entries | -1 (unlimited) | The maximum number of errors that should be written per MR task. g |
| das.error.log.replication-factor | 1 | The replication factor for the error-logs which are getting written for dropped records. |
| das.join.deferred-file.memory-threshold | 52428800 (50MB) | Maximum size of memory which is used to cache values before falling back to file. This property is used in self joins and from the join strategies REDUCE_SIDE and PRE_SORT_MAP_SIDE. |
| das.join.map-side.memory.max-file-size | 15728640 (15MB) | Maximum size for the smaller join file of a join. Spectrum uses different join strategies. The fastest join strategy is when one input of the two fits into memory. This property marks the upper bound when a file, depending on its size, is assumed to fit into memory. Note that depending on compression and record-structure a 15 MB file on disk can easily blow up to 500 MB in memory. |
| das.join.disabled-strategies | empty | A comma separated list of Join strategies which should explicitly not be used. Available are MEMORY_BACKED_MAP_SIDE, REDUCE_SIDE and PRE_SORT_MAP_SIDE. |
| das.jdbc.import.transaction-isolation | TRANSACTION_READ_COMMITTED | The jdbc transaction-level which should be used for imports from database. You can choose between TRANSACTION_NONE, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ and TRANSACTION_SERIALIZABLE which corresponds to the transaction-isolation levels from java.sql.Connection. |
| das.job.trigger.type | Tells who/what triggered a job. (USER, SCHEDULER, RESTAPI, IMPORTJOB, EXPORTJOB, WORKBOOK). | |
| das.job.hdfs.ownership | The name of the owner for each file and folder that will be created during a job run in HDFS. | |
| das.job.hdfs.groupname | The name of the group for each file and folder that will be created during a job run in HDFS. | |
| das.job.execution.username | The name of the user thats executes the job. | |
| das.job.configuration.owner.username | The name of the user thats the owns the configuration of the job. | |
| das.debug.tasks.logs.collect.max | 20 | Number of task-logs which getting copied into job-artifacts folder when job completes. |
| das.debug.tasks.logs.collect.force | false | When true, copies the task-logs into job-artifacts folder even when job completes successfully. |
| das.splitting.max-split-count | Spectrum merges multiple small files into combined splits and splits large files into multiple smaller splits. Setting this property can control the maximum number of splits that should be created. This is good to reduce the number of file handlers due to a lack of RPC resources. | |
| das.splitting.min-split-count | Sets the minimum number of splits that should be created. This could be used in increase the number of map-tasks for smaller jobs to better utilize the cluster. | |
| das.jdbc.records.per.commit | 50 | Sets the JDBC batch size for export jobs. Helpful on debugging export issues during JDBC batch commit. |
| das.debug.job | false | Shortcut property for enabling a set of debug related properties for map-reduce jobs like periodic thread-dumps, periodic counter dumps, task-log retrieval, etc.. |
| das.debug.periodic-thread-dumps-period | (-1=disabled, >0 enabled) | A thread dump is taken every x ms and logged to stdout (so it ends in the task-logs). |
| das.debug.periodic-counter-dumps-period | (-1=disabled, >0 enabled) | A hadoop-counter dump is taken every x ms and logged to stdout (so it ends in the task-logs). |
| das.sampling.lookahead.maxdepth | 5 | Smart sampling uses information from the downstream sheets in a Workbook while sampling data for the preview of a sheet. This parameter sets the number of downstream levels which are considered. |
| das.map-tasks-per-node | 10 | Set the number of map tasks per node. |
| das.reduce-tasks-per-node | 7 | Set the number of reduce tasks per node. |
| das.job.reduce .tasks.correct | true | If the reducer count should be adapted based on the split-count (map-task count). |
| das.job.concurrent-mr-jobs.new-graph-api | 5 | Only for new graph API: The maximum number of MR jobs that can run concurrently for each Spectrum job. |
| das.aggregation.map-cache-size | ByteUnit.MB.toBytes(16) | Size of Cache for Map-Side Aggregation in bytes. Less than or equal to 0 means disable Map-Side Aggregation. |
| das.debug.job-metadata | enabled | Possible values are these from the enum JobMetaDataMode (ENABLED, DISABLED, DEFLATED) |
| das.debug.job.report-progress-interval | -1 | Interval in milliseconds a reporting thread will report progress to hadoop's tasktracker. If set to <= 0 no thread will be installed and progress is reported by mappers, reducers, readers, etc... as usual. |
| das.jobconf .cache-properties | Properties like " das.plugin-registry.conf,map-runnable,reducer,mapred.input.dir" | Properties are evacuated to the distributed cache. Evacuation means, before submitting the job, the properties are stripped out of the job-conf and written into one file in the distributed cache. On a task side, before any serious work happens, the properties are read from the distributed cache and added to the job-conf. Disable the whole mechanism by setting ' das.jobconf .cache-properties' to ''. |
| das.job.map -task.memory | 2048 | |
| das.job.reduce -task.memory | 2048 | |
| das.job.application-manager.memory | 2048 | |
| das.job.reduce .tasks | -1 | {@link spectrum.dap.sdk.util.HadoopConstants.MAPRED#REDUCE_TASKS} is calculated dynamically. If for any reason you want to enforce a specific reduce count, set this property to greater then zero. |
| das.error.log.replication-factor | 2 | The replication factor for the error-logs which are getting written for dropped records. |
| das.splitting.map-wave-count | 3 | The map-wave-count to influence the number of map-task DAS uses for internal and for file-based import jobs. |
| das.splitting.map-slots.safety-factor | 1 | The number of map-slots which isn't used for the last map-wave in order to absorb node-failures. |
| das.splitting.disable-combining | false | Determines how splitting occurs. Setting the value to true ensures that a files are not split based on blocks. |
| das.splitting.disable-individual-file-splitting | false | Determines how splitting occurs for an individual file. Setting the value to true ensures that a single file isn't split based on its blocks. |
| das.splitting.max-rewind-count | 1024 * 1024 * 10 | For support of {@link MultipleSourceRecordParser}. Determines the number of bytes a middle-split is rewinded at the maximum in case the split doesn't start with a valid raw-record. |
| das.splitting.max-split-count | Spectrum merges multiple small files into combined splits and splits large files into multiple smaller splits. Setting this property can control the maximum number of splits that should be created. This is good to reduce the number of file handlers due to a lack of RPC resources. | |
| das.splitting.non-splittable-encodings | UTF-16, UTF-16BE, UTF-16LE | Lists the file encodings for which splitting is restricted to only file level. For example, a file with this kind of encoding is not split at the block level. |
| das.join.deferred-file.memory-threshold | 52428800 | Maximum size of memory which is used to cache values during join before falling back to file. 50 MB default. |
| das.join.map-side.memory.max-uncompressed-file-size | 31457280 | |
| das.join.map-side.memory.max-file-size | 10485760 | |
| das.join.disabled-strategies | ||
| das.range-join.map-side.max-uncompressed-file-size | 31457280 | Max uncompressed file size the file can have that we attempt to load into memory for a map-side range join. |
| das.range-join.map-side.max-records | 10000 | Max number of records the file can have that we attempt to load into memory for a map-side range join. |
| das.range-join.reduce-side.max-reducers | -1 | Max number of reducers to use for reduce-side range join implementation, -1 mean determine based on input sizing. |
| das.range-join.reduce-side.min-bytes-per-reducer | 536870912 | Minimum number of bytes each reducer should see, used by auto reducer count algorithm to help determine the number of reducers. |
| das.range-join.reduce-side.volume-weighting-factor | 0.7 | Factor to control weighting of the reducer data volume when determining the number of reducers for the reduce-side range join. |
| das.cluster.hadoop.fs.cache.scheme.whitelist | scp,sftp | Allows using the Hadoop FileServer cache on the cluster; with the FileServer cache enabled for SCP/ SFTP scheme, there will be a single SSH connection for each 'das.cluster.hadoop.fs.cache.scheme.whitelist=scp,sftp'. |
das-conductor.properties#
| Name | Default Value | Description |
|---|---|---|
| das.preview.expression.records.max | 100 | Maximum array size that a function may return for previews. If this value is exceeded the excess records are chopped off. This is only used on the Spectrum server to keep the previews small. |
| das.big-decimal.precision | 32 | During data ingestion, data field types of big integer and big decimal have the maximum precision rounded to this value. |
| das.expression.records.max | Integer.MAX_VALUE | Maximum array size that a function may return. If this value is exceeded the excess records are chopped off. |
| das.group-series-expression.records.max | -1 | Maximum number of records a group series expression can generate. |
| das.preview .generation.additional-records-ratio | 0.2f | All tasks together will try to create a preview of maxPreviewSize*the-configured-ratio in order to balance tasks with less records. |
| das.preview .group-series-expression.records.max | 100 | Maximum number of records a group series expression can generate for a preview. |
| das.jdbc.imp ort.sql.badwords | commit, savepoint, rollback, set, checkpoint, grant, revoke, insert, update, delete, index, alter, create, lock, drop, truncate, ;, rename, comment, call, merge, explain, shutdown, show, describe, exec, go, declare | List of words that are not allowed in SQL entered by the user in SQL import. The string is broken up at the ',' and any spaces are part of the bad words. The string is parsed as a String[]. INFO This property should be updated on the das-conductor.properties file. After updating this property, restart Spectrum. |
Examples of bad word SQL
Examples of bad word SQL#
select * from mytable;-- semicolon is invaliddrop database dap-- drop is invalidcreate table ...-- create is invalidselect "savepoint", * from table-- currently the bad words can't show up in column names or data either
List of Hadoop Properties#
| Name | Default Value | Description |
|---|---|---|
| fs.AbstractFileSystem.hdfs.impl | org.apache.hadoop.fs.Hdfs | Property is required for successfully starting yarn application as these properties are stripped out while setting up the overlay by DAS framework. |
| io.compression.codecs.addition | spectrum.dap.common.util.ZipCodec,datameer.dap.common.util.LzwCodec | Property is required for successfully starting yarn application as these properties are stripped out while setting up the overlay by DAS framework. Additional comma=separated compression codecs that are added to io.compression.codecs |
| das.yarn.available-node-vcores | auto | This property sets the number of available node vcores and is used in order to calculate the optimal number of splits and tasks (numberOfNodes * das.yarn.available-node-vcores). It can be set either to the number of free CPUs per node, or it can be set to auto. In auto mode, Spectrum fetches information about the vCores from every node and sets das.yarn.available-node-vcores to the average of the available vCores. |
| das.job.health.check | true | Turn das job configuration health check on for cluster configuration. |
| das.local.exec.map.count | 5 | DAS property to influence the number of mappers in Local Execution mode. |
List of Hive Properties#
| Name | Default Value | Description |
|---|---|---|
| dap.hive.use-datameer-file-splitter | fales | Property decides whether Spectrum should use Spectrum's FileSplitter logic to generate RewindableFileSplits or Hive's own splitting logic. |
List of Execution Framework Properties#
General#
| Name | Default Value | Description |
|---|---|---|
| das.execution-framework | Tez | Sets the execution framework e.g. 'das.execution-framework=Spark' to run Spark as the execution framework or 'das.execution-framework=Tez' to run Tez as the execution framework. |
TEZ#
| Name | Default Value | Description |
|---|---|---|
| das.tez.session-pool.max-cached-sessions | auto | Maximum number of idle session to be held in cache. 0 means no session pooling, auto uses the number of nodes in the cluster as value for the maximum number of sessions. |
| das.tez.session-pool.max-idle-time | 2m | The timeout for the sessions held in pool for which they wait for DAG to be submitted. |
| das.tez.session-pool.max-time-to-live | 2h | Maximum amount of time a tez session will be alive irrespective of being idle or active since its start time. |
| tez.runtime.compress | true | Settings for intermediate compression with Tez. |
| tez.runtime.compress.codec | org.apache.hadoop.io.compress.SnappyCodec | Settings for intermediate compression with Tez. |
| framework.local.das.parquet-storage.max-parquet-block-size | 67108864 | For local execution framework setting the max parquet block size to 64MB(can't be raised beyond 64MB but, can be lowered) by default. |
| tez.shuffle-vertex-manager.desired-task-input-size | 52428800 | Sets the input size for each TEZ sub-task. |
| das.cluster.plugin.resources.fixer.enabled | true | Intercepts the YARN errors YARN-3591 and YARN 6641 and rebuilds the missing plug-in class files on the fly. Setting the value to 'false' disables the property. |
YARN MR2#
| Name | Default Value | Description |
|---|---|---|
| das.yarn.base-counter-wait-time | 40000 | YARN Counters take a while to show up at the Job History Server, so we use this base wait time + a small factor * the number of executed tasks to wait for the counters to finally show up. |
List of Smart Execution Properties#
INFO
These properties are exclusively for the Smart Execution license.
| Name | Default Value | Description |
|---|---|---|
| tez.am.shuffle-vertex-manager.desired-task-input-size | 50 | Set the input size for each TEZ sub-task. |
| das.execution-framework | smart | Force a job to be run with a specific execution framework Smart Execution = Smart Optimized MapReduce = Tez SmallJob Execution = SmallJob Spark Smart Execution = Smart Local Mode = local (default and the only execution framework in local mode) |
| das.execution-framework.small-job.max-records | 1000000 | Set a threshold size for number of records to choose execution framework. |
| das.execution-framework.small-job.max-uncompressed | 1000000000 | Set a threshold size for uncompressed file size to choose execution framework. |
List of Windows Properties#
| Name | Default Value | Description |
|---|---|---|
| windows.das.join.disabled-strategies | MEMORY_BACKED_MAP_SIDE | By default, memory backed joins are enabled on Windows platform, if required to disable, please uncomment the property. |
| mapreduce.input.linerecordreader.line.maxlength | 2097152 | Controls the maximum line size (in characters) allowed before filtering it on read. Below value is around a maximum of 4MB per line. |
List of Error Handling Properties#
| Name | Default Value | Description |
|---|---|---|
| Workbook.error-handling.default | IGNORE | Legal values for Workbook error handling are IGNORE, DROP_RECORD, ABORT_JOB. The equivalent error handling modes in the UI are Ignore, Skip and Abort. |
| export-job.error-handling.default | DROP_RECORD | Legal values for export job error handling are IGNORE, DROP_RECORD, ABORT_JOB. The equivalent error handling modes in the UI are Ignore error, Drop record and Abort job. |
| import-job.error-handling.default | DROP_RECORD | Legal values for import job error handling are DROP_RECORD, ABORT_JOB. The equivalent error handling modes in the UI are Drop record and Abort job. |
| data-link.error-handling.default | DROP_RECORD | Legal values for data link error handling are DROP_RECORD, ABORT_JOB. The equivalent error handling modes in the UI are Drop record and Abort job. |
Adding a Custom Property#
INFO
Custom properties can be added to apply system-wide or to apply only for specific jobs.
Adding Custom Properties Applied to all Jobs#
To add a system-wide custom property:
-
Click on the "Admin" tab and select the menu tab "Hadoop Cluster". *The overview page for the Hadoop Cluster configuration opens. *
-
Click on "Enter". The Hadoop Cluster configuration page opens.
-
Enter the custom properties in the field "Custom Properties" and confirm with "Enter". The configuration is saved.
Adding Custom Properties Applied to Specific a Workbook Job#
To add a Workbook job specific custom property:
-
Double-click the required Workbook from the File Browser. The Workbook opens.
-
Select "File" and select "Configure". The Workbook configuration page opens.
-
Enter the required custom properties in the field "Custom Properties" and confirm with "Save". The Workbook job configuration is saved.
Editing Custom Properties for Compressed Data#
When importing compressed data, the requirements are different for settings custom properties than other custom properties.
To decompress data you're importing, all compression codec details need
to be put within the conf/das-common.properties files.
This includes, for LZO compression:
io.compression.codecsio.compression.codec.lzo.classmapred.map.output.compression.codec
As a best practice, put all compression details in the properties files, and adjust their tuning parameters, if necessary, in the interface.