Skip to main content

Databricks Streaming Loader configuration reference

The configuration reference in this page is written for Databricks Streaming Loader 0.1.0

License

The Databricks Streaming Loader is released under the Snowplow Limited Use License (FAQ).

To accept the terms of license and run the loader, set the ACCEPT_LIMITED_USE_LICENSE=yes environment variable. Alternatively, configure the license.accept option in the config file:

"license": {
"accept": true
}

Databricks configuration

ParameterDescription
output.good.hostRequired, e.g. https://{workspace-id}.cloud.databricks.com. URL of the Databricks workspace.
output.good.catalogRequired. Name of the Databricks catalog containing the volume.
output.good.schemaRequired. Name of the Databricks schema containing the volume.
output.good.volumeRequired. Name of the Databricks volume to which this loader will upload staging files. This must be an external volume.
output.good.tokenRequired if using PAT authentication. A Databricks personal access token.
output.good.oauth.clientIdRequired if using OAUTH authentication. The client ID for a Databricks service principal.
output.good.oauth.clientSecretRequired if using OAUTH authentication. The client secret for a Databricks service principal.
output.good.compressionOptional. Default value snappy. Compression algorithm for the uploaded staging parquet files.

Streams configuration

ParameterDescription
input.streamNameRequired. Name of the Kinesis stream with the enriched events
input.appNameOptional, default snowplow-databricks-loader. Name to use for the dynamodb table, used by the underlying Kinesis Consumer Library for managing leases.
input.initialPosition.typeOptional, default LATEST. Allowed values are LATEST, TRIM_HORIZON, AT_TIMESTAMP. When the loader is deployed for the first time, this controls from where in the kinesis stream it should start consuming events. On all subsequent deployments of the loader, the loader will resume from the offsets stored in the DynamoDB table.
input.initialPosition.timestampRequired if input.initialPosition is AT_TIMESTAMP. A timestamp in ISO8601 format from where the loader should start consuming events.
input.retrievalModeOptional, default Polling. Change to FanOut to enable the enhance fan-out feature of Kinesis.
input.retrievalMode.maxRecordsOptional. Default value 1000. How many events the Kinesis client may fetch in a single poll. Only used when `input.retrievalMode` is Polling.
input.workerIdentifierOptional. Defaults to the HOSTNAME environment variable. The name of this KCL worker used in the dynamodb lease table.
input.leaseDurationOptional. Default value 10 seconds. The duration of shard leases. KCL workers must periodically refresh leases in the dynamodb table before this duration expires.
input.maxLeasesToStealAtOneTimeFactorOptional. Default value 2.0. Controls how to pick the max number of shard leases to steal at one time. E.g. If there are 4 available processors, and maxLeasesToStealAtOneTimeFactor = 2.0, then allow the loader to steal up to 8 leases. Allows bigger instances to more quickly acquire the shard-leases they need to combat latency.
input.checkpointThrottledBackoffPolicy.minBackoffOptional. Default value 100 milliseconds. Initial backoff used to retry checkpointing if we exceed the DynamoDB provisioned write limits.
input.checkpointThrottledBackoffPolicy.maxBackoffOptional. Default value 1 second. Maximum backoff used to retry checkpointing if we exceed the DynamoDB provisioned write limits.
output.bad.streamNameRequired. Name of the Kinesis stream that will receive failed events.
output.bad.throttledBackoffPolicy.minBackoffOptional. Default value 100 milliseconds. Initial backoff used to retry sending failed events if we exceed the Kinesis write throughput limits.
output.bad.throttledBackoffPolicy.maxBackoffOptional. Default value 1 second. Maximum backoff used to retry sending failed events if we exceed the Kinesis write throughput limits.
output.bad.recordLimitOptional. Default value 500. The maximum number of records we are allowed to send to Kinesis in 1 PutRecords request.
output.bad.byteLimitOptional. Default value 5242880. The maximum number of bytes we are allowed to send to Kinesis in 1 PutRecords request.
output.bad.maxRecordSizeOptional. Default value 1000000. Any single event failed event sent to Kinesis should not exceed this size in bytes

Other configuration options

ParameterDescription
batching.maxBytesOptional. Default value 16000000. Events are uploaded to the Databricks volume when the batch reaches this size in bytes
batching.maxDelayOptional. Default value 1 second. Events are uploaded to the Databricks volume after a maximum of this duration, even if the maxBytes size has not been reached
batching.uploadConcurrencyOptional. Default value 3. Controls how many batches can we send simultaneously over the network to Databricks
retries.setupErrors.delayOptional. Default value 30 seconds. Configures exponential backoff on errors related to how Databricks is set up for this loader. Examples include authentication errors and permissions errors. This class of errors are reported periodically to the monitoring webhook.
retries.transientErrors.delayOptional. Default value 1 second. Configures exponential backoff on errors that are likely to be transient. Examples include server errors and network errors.
retries.transientErrors.attemptsOptional. Default value 5. Maximum number of attempts to make before giving up on a transient error.
skipSchemasOptional, e.g. ["iglu:com.example/skipped1/jsonschema/1-0-0"] or with wildcards ["iglu:com.example/skipped2/jsonschema/1-*-*"]. A list of schemas that won't be loaded to Databricks. This feature could be helpful when recovering from edge-case schemas which for some reason cannot be loaded to the table.
exitOnMissingIgluSchemaOptional. Default value true. Whether the loader should crash and exit if it fails to resolve an Iglu Schema. We recommend `true` because Snowplow enriched events have already passed validation, so a missing schema normally indicates an error that needs addressing. Change to false so events go the failed events stream instead of crashing the loader.
monitoring.metrics.statsd.hostnameOptional. If set, the loader sends statsd metrics over UDP to a server on this host name.
monitoring.metrics.statsd.portOptional. Default value 8125. If the statsd server is configured, this UDP port is used for sending metrics.
monitoring.metrics.statsd.tags.*Optional. A map of key/value pairs to be sent along with the statsd metric.
monitoring.metrics.statsd.periodOptional. Default 1 minute. How often to report metrics to statsd.
monitoring.metrics.statsd.prefixOptional. Default snowplow.databricks-loader. Prefix used for the metric name when sending to statsd.
monitoring.webhook.endpointOptional, e.g. https://webhook.example.com. The loader will send to the webhook a payload containing details of any error related to how Databricks is set up for this loader.
monitoring.webhook.tags.*Optional. A map of key/value strings to be included in the payload content sent to the webhook.
monitoring.webhook.heartbeat.*Optional. Default value 5.minutes. How often to send a heartbeat event to the webhook when healthy.
monitoring.sentry.dsnOptional. Set to a Sentry URI to report unexpected runtime exceptions.
monitoring.sentry.tags.*Optional. A map of key/value strings which are passed as tags when reporting exceptions to Sentry.
telemetry.disableOptional. Set to true to disable telemetry.
telemetry.userProvidedIdOptional. See here for more information.
http.client.maxConnectionsPerServer Optional. Default value 4. Configures the internal HTTP client used for iglu resolver, alerts and telemetry. The maximum number of open HTTP requests to any single server at any one time.

On this page

Want to see a custom demo?

Our technical experts are here to help.