This is an automated email from the ASF dual-hosted git repository.
victoria pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git
The following commit(s) were added to refs/heads/master by this push:
new 5f74ef56f1 Clean up Kafka supervisor topic (#14651)
5f74ef56f1 is described below
commit 5f74ef56f1803771128780444effdb37e019aa7e
Author: Katya Macedo <[email protected]>
AuthorDate: Mon Aug 21 13:55:38 2023 -0500
Clean up Kafka supervisor topic (#14651)
Co-authored-by: Charles Smith <[email protected]>
---
docs/configuration/index.md | 2 +-
.../extensions-core/kafka-supervisor-operations.md | 4 +-
.../extensions-core/kafka-supervisor-reference.md | 287 ++++++++++-----------
docs/ingestion/ingestion-spec.md | 2 +-
docs/tutorials/tutorial-jupyter-docker.md | 2 +-
.../druid-models/ingestion-spec/ingestion-spec.tsx | 4 +-
6 files changed, 147 insertions(+), 154 deletions(-)
diff --git a/docs/configuration/index.md b/docs/configuration/index.md
index deb1e7c541..a234659e9b 100644
--- a/docs/configuration/index.md
+++ b/docs/configuration/index.md
@@ -1196,7 +1196,7 @@ There are additional configs for autoscaling (if it is
enabled):
|`druid.supervisor.idleConfig.enabled`|If `true`, supervisor can become idle
if there is no data on input stream/topic for some time.|false|
|`druid.supervisor.idleConfig.inactiveAfterMillis`|Supervisor is marked as
idle if all existing data has been read from input topic and no new data has
been published for `inactiveAfterMillis` milliseconds.|`600_000`|
-The `druid.supervisor.idleConfig.*` specified in the runtime properties of the
overlord defines the default behavior for the entire cluster. See [Idle
Configuration in Kafka Supervisor
IOConfig](../development/extensions-core/kafka-supervisor-reference.md#kafkasupervisorioconfig)
to override it for an individual supervisor.
+The `druid.supervisor.idleConfig.*` specified in the Overlord runtime
properties defines the default behavior for the entire cluster. See [Idle
Configuration in Kafka Supervisor
IOConfig](../development/extensions-core/kafka-supervisor-reference.md#supervisor-io-configuration)
to override it for an individual supervisor.
#### Overlord dynamic configuration
diff --git a/docs/development/extensions-core/kafka-supervisor-operations.md
b/docs/development/extensions-core/kafka-supervisor-operations.md
index 9b6265154c..8504ced595 100644
--- a/docs/development/extensions-core/kafka-supervisor-operations.md
+++ b/docs/development/extensions-core/kafka-supervisor-operations.md
@@ -263,11 +263,11 @@ and begin publishing their segments. A new supervisor
will then be started which
will start reading from the offsets where the previous now-publishing tasks
left off, but using the updated schema.
In this way, configuration changes can be applied without requiring any pause
in ingestion.
-## Deployment Notes on Kafka partitions and Druid segments
+## Deployment notes on Kafka partitions and Druid segments
Druid assigns each Kafka indexing task Kafka partitions. A task writes the
events it consumes from Kafka into a single segment for the segment granularity
interval until it reaches one of the following: `maxRowsPerSegment`,
`maxTotalRows` or `intermediateHandoffPeriod` limit. At this point, the task
creates a new partition for this segment granularity to contain subsequent
events.
-The Kafka Indexing Task also does incremental hand-offs. Therefore segments
become available as they are ready and you do not have to wait for all segments
until the end of the task duration. When the task reaches one of
`maxRowsPerSegment`, `maxTotalRows`, or `intermediateHandoffPeriod`, it hands
off all the segments and creates a new new set of segments will be created for
further events. This allows the task to run for longer durations without
accumulating old segments locally on Mi [...]
+The Kafka Indexing Task also does incremental hand-offs. Therefore segments
become available as they are ready and you do not have to wait for all segments
until the end of the task duration. When the task reaches one of
`maxRowsPerSegment`, `maxTotalRows`, or `intermediateHandoffPeriod`, it hands
off all the segments and creates a new new set of segments will be created for
further events. This allows the task to run for longer durations without
accumulating old segments locally on Mid [...]
The Kafka Indexing Service may still produce some small segments. For example,
consider the following scenario:
- Task duration is 4 hours
diff --git a/docs/development/extensions-core/kafka-supervisor-reference.md
b/docs/development/extensions-core/kafka-supervisor-reference.md
index 95d6b58018..d141b23477 100644
--- a/docs/development/extensions-core/kafka-supervisor-reference.md
+++ b/docs/development/extensions-core/kafka-supervisor-reference.md
@@ -23,78 +23,103 @@ description: "Reference topic for Apache Kafka supervisors"
~ specific language governing permissions and limitations
~ under the License.
-->
-This topic contains configuration reference information for the Apache Kafka
supervisor for Apache Druid. The following table outlines the high-level
configuration options:
-
-|Field|Description|Required|
-|--------|-----------|---------|
-|`type`|Supervisor type. For Kafka streaming, set to `kafka`.|yes|
-|`spec`| Container object for the supervisor configuration. | yes |
-|`dataSchema`|Schema for the Kafka indexing task to use during ingestion.|yes|
-|`ioConfig`|A `KafkaSupervisorIOConfig` object to define the Kafka connection
and I/O-related settings for the supervisor and indexing task. See
[KafkaSupervisorIOConfig](#kafkasupervisorioconfig).|yes|
-|`tuningConfig`|A KafkaSupervisorTuningConfig object to define
performance-related settings for the supervisor and indexing tasks. See
[KafkaSupervisorTuningConfig](#kafkasupervisortuningconfig).|no|
-
-## KafkaSupervisorIOConfig
-
-|Field|Type|Description|Required|
-|-----|----|-----------|--------|
-|`topic`|String|The Kafka topic to read from. Must be a specific topic. Use
this setting when you want to ingest from a single Kafka topic.|yes, only if
`topicPattern` is not set|
-|`topicPattern`|String|A regex pattern that can used to select multiple Kafka
topics to ingest data from. Either this or `topic` can be used in a spec. See
[Ingesting from multiple topics](#ingesting-from-multiple-topics) for more
details.|yes, only if `topic` is not set|
-|`inputFormat`|Object|`inputFormat` to define input data parsing. See
[Specifying data format](#specifying-data-format) for details about specifying
the input format.|yes|
-|`consumerProperties`|Map<String, Object>|A map of properties to pass to the
Kafka consumer. See [More on consumer
properties](#more-on-consumerproperties).|yes|
-|`pollTimeout`|Long|The length of time to wait for the Kafka consumer to poll
records, in milliseconds|no (default == 100)|
-|`replicas`|Integer|The number of replica sets. "1" means a single set of
tasks without replication. Druid always assigns replica tasks to different
workers to provide resiliency against worker failure.|no (default == 1)|
-|`taskCount`|Integer|The maximum number of *reading* tasks in a *replica set*.
The maximum number of reading tasks equals `taskCount * replicas`. Therefore,
the total number of tasks, *reading* + *publishing*, is greater than this
count. See [Capacity
Planning](./kafka-supervisor-operations.md#capacity-planning) for more details.
When `taskCount > {numKafkaPartitions}`, the actual number of reading tasks is
less than the `taskCount` value.|no (default == 1)|
-|`taskDuration`|ISO8601 Period|The length of time before tasks stop reading
and begin publishing segments.|no (default == PT1H)|
-|`startDelay`|ISO8601 Period|The period to wait before the supervisor starts
managing tasks.|no (default == PT5S)|
-|`period`|ISO8601 Period|Frequency at which the supervisor executes its
management logic. The supervisor also runs in response to certain events. For
example, task success, task failure, and tasks reaching their `taskDuration`.
The `period` value specifies the maximum time between iterations.|no (default
== PT30S)|
-|`useEarliestOffset`|Boolean|If a supervisor manages a `dataSource` for the
first time, it obtains a set of starting offsets from Kafka. This flag
determines whether it retrieves the earliest or latest offsets in Kafka. Under
normal circumstances, subsequent tasks will start from where the previous
segments ended. Therefore Druid only uses `useEarliestOffset` on first run.|no
(default == false)|
-|`completionTimeout`|ISO8601 Period|The length of time to wait before
declaring a publishing task as failed and terminating it. If the value is too
low, your tasks may never publish. The publishing clock for a task begins
roughly after `taskDuration` elapses.|no (default == PT30M)|
-|`lateMessageRejectionStartDateTime`|ISO8601 DateTime|Configure tasks to
reject messages with timestamps earlier than this date time; for example if
this is set to `2016-01-01T11:00Z` and the supervisor creates a task at
*2016-01-01T12:00Z*, Druid drops messages with timestamps earlier than
*2016-01-01T11:00Z*. This can prevent concurrency issues if your data stream
has late messages and you have multiple pipelines that need to operate on the
same segments (e.g. a realtime and a nightly [...]
-|`lateMessageRejectionPeriod`|ISO8601 Period|Configure tasks to reject
messages with timestamps earlier than this period before the task was created;
for example if this is set to `PT1H` and the supervisor creates a task at
*2016-01-01T12:00Z*, messages with timestamps earlier than *2016-01-01T11:00Z*
will be dropped. This may help prevent concurrency issues if your data stream
has late messages and you have multiple pipelines that need to operate on the
same segments (e.g. a realtime an [...]
-|`earlyMessageRejectionPeriod`|ISO8601 Period|Configure tasks to reject
messages with timestamps later than this period after the task reached its
taskDuration; for example if this is set to `PT1H`, the taskDuration is set to
`PT1H` and the supervisor creates a task at *2016-01-01T12:00Z*, messages with
timestamps later than *2016-01-01T14:00Z* will be dropped. **Note:** Tasks
sometimes run past their task duration, for example, in cases of supervisor
failover. Setting earlyMessageReject [...]
-|`autoScalerConfig`|Object|Defines auto scaling behavior for Kafka ingest
tasks. See [Tasks Autoscaler Properties](#task-autoscaler-properties).|no
(default == null)|
-|`idleConfig`|Object|Defines how and when Kafka Supervisor can become idle.
See [Idle Supervisor Configuration](#idle-supervisor-configuration) for more
details.|no (default == null)|
-
-## Task Autoscaler Properties
-
-| Property | Description | Required |
-| ------------- | ------------- | ------------- |
-| `enableTaskAutoScaler` | Enable or disable autoscaling. `false` or blank
disables the `autoScaler` even when `autoScalerConfig` is not null| no (default
== false) |
-| `taskCountMax` | Maximum number of ingestion tasks. Set `taskCountMax >=
taskCountMin`. If `taskCountMax > {numKafkaPartitions}`, Druid only scales
reading tasks up to the `{numKafkaPartitions}`. In this case `taskCountMax` is
ignored. | yes |
-| `taskCountMin` | Minimum number of ingestion tasks. When you enable
autoscaler, Druid ignores the value of taskCount in `IOConfig` and starts with
the `taskCountMin` number of tasks.| yes |
-| `minTriggerScaleActionFrequencyMillis` | Minimum time interval between two
scale actions. | no (default == 600000) |
-| `autoScalerStrategy` | The algorithm of `autoScaler`. Only supports
`lagBased`. See [Lag Based AutoScaler Strategy Related
Properties](#lag-based-autoscaler-strategy-related-properties) for details.| no
(default == `lagBased`) |
-
-## Lag Based AutoScaler Strategy Related Properties
-| Property | Description | Required |
-| ------------- | ------------- | ------------- |
-| `lagCollectionIntervalMillis` | Period of lag points collection. | no
(default == 30000) |
-| `lagCollectionRangeMillis` | The total time window of lag collection. Use
with `lagCollectionIntervalMillis`，it means that in the recent
`lagCollectionRangeMillis`, collect lag metric points every
`lagCollectionIntervalMillis`. | no (default == 600000) |
-| `scaleOutThreshold` | The threshold of scale out action | no (default ==
6000000) |
-| `triggerScaleOutFractionThreshold` | If `triggerScaleOutFractionThreshold`
percent of lag points are higher than `scaleOutThreshold`, then do scale out
action. | no (default == 0.3) |
-| `scaleInThreshold` | The Threshold of scale in action | no (default ==
1000000) |
-| `triggerScaleInFractionThreshold` | If `triggerScaleInFractionThreshold`
percent of lag points are lower than `scaleOutThreshold`, then do scale in
action. | no (default == 0.9) |
-| `scaleActionStartDelayMillis` | Number of milliseconds after supervisor
starts when first check scale logic. | no (default == 300000) |
-| `scaleActionPeriodMillis` | The frequency of checking whether to do scale
action in millis | no (default == 60000) |
-| `scaleInStep` | How many tasks to reduce at a time | no (default == 1) |
-| `scaleOutStep` | How many tasks to add at a time | no (default == 2) |
-
-## Idle Supervisor Configuration
-:::info
- Note that Idle state transitioning is currently designated as experimental.
-:::
+This topic contains configuration reference information for the Apache Kafka
supervisor for Apache Druid.
+
+The following table outlines the high-level configuration options:
+
+|Property|Type|Description|Required|
+|--------|----|-----------|--------|
+|`type`|String|The supervisor type. For Kafka streaming, set to `kafka`.|Yes|
+|`spec`|Object|The container object for the supervisor configuration.|Yes|
+|`ioConfig`|Object|The I/O configuration object to define the Kafka connection
and I/O-related settings for the supervisor and indexing task. See [Supervisor
I/O configuration](#supervisor-io-configuration).|Yes|
+|`dataSchema`|Object|The schema for the Kafka indexing task to use during
ingestion.|Yes|
+|`tuningConfig`|Object|The tuning configuration object to define
performance-related settings for the supervisor and indexing tasks. See
[Supervisor tuning configuration](#supervisor-tuning-configuration).|No|
+
+## Supervisor I/O configuration
+
+The following table outlines the configuration options for `ioConfig`:
+
+|Property|Type|Description|Required|Default|
+|--------|----|-----------|--------|-------|
+|`topic`|String|The Kafka topic to read from. Must be a specific topic. Druid
does not support topic patterns.|Yes||
+|`inputFormat`|Object|The input format to define input data parsing. See
[Specifying data format](#specifying-data-format) for details about specifying
the input format.|Yes||
+|`consumerProperties`|String, Object|A map of properties to pass to the Kafka
consumer. See [Consumer properties](#consumer-properties).|Yes||
+|`pollTimeout`|Long|The length of time to wait for the Kafka consumer to poll
records, in milliseconds.|No|100|
+|`replicas`|Integer|The number of replica sets, where 1 is a single set of
tasks (no replication). Druid always assigns replicate tasks to different
workers to provide resiliency against process failure.|No|1|
+|`taskCount`|Integer|The maximum number of reading tasks in a replica set. The
maximum number of reading tasks equals `taskCount * replicas`. The total number
of tasks, reading and publishing, is greater than this count. See [Capacity
planning](./kafka-supervisor-operations.md#capacity-planning) for more details.
When `taskCount > {numKafkaPartitions}`, the actual number of reading tasks is
less than the `taskCount` value.|No|1|
+|`taskDuration`|ISO 8601 period|The length of time before tasks stop reading
and begin publishing segments.|No|PT1H|
+|`startDelay`|ISO 8601 period|The period to wait before the supervisor starts
managing tasks.|No|PT5S|
+|`period`|ISO 8601 period|Determines how often the supervisor executes its
management logic. Note that the supervisor also runs in response to certain
events, such as tasks succeeding, failing, and reaching their task duration.
The `period` value specifies the maximum time between iterations.|No|PT30S|
+|`useEarliestOffset`|Boolean|If a supervisor manages a datasource for the
first time, it obtains a set of starting offsets from Kafka. This flag
determines whether it retrieves the earliest or latest offsets in Kafka. Under
normal circumstances, subsequent tasks start from where the previous segments
ended. Druid only uses `useEarliestOffset` on the first run.|No|`false`|
+|`completionTimeout`|ISO 8601 period|The length of time to wait before
declaring a publishing task as failed and terminating it. If the value is too
low, your tasks may never publish. The publishing clock for a task begins
roughly after `taskDuration` elapses.|No|PT30M|
+|`lateMessageRejectionStartDateTime`|ISO 8601 date time|Configure tasks to
reject messages with timestamps earlier than this date time. For example, if
this property is set to `2016-01-01T11:00Z` and the supervisor creates a task
at `2016-01-01T12:00Z`, Druid drops messages with timestamps earlier than
`2016-01-01T11:00Z`. This can prevent concurrency issues if your data stream
has late messages and you have multiple pipelines that need to operate on the
same segments, such as a realtime [...]
+|`lateMessageRejectionPeriod`|ISO 8601 period|Configure tasks to reject
messages with timestamps earlier than this period before the task was created.
For example, if this property is set to `PT1H` and the supervisor creates a
task at `2016-01-01T12:00Z`, Druid drops messages with timestamps earlier than
`2016-01-01T11:00Z`. This may help prevent concurrency issues if your data
stream has late messages and you have multiple pipelines that need to operate
on the same segments, such as a r [...]
+|`earlyMessageRejectionPeriod`|ISO 8601 period|Configure tasks to reject
messages with timestamps later than this period after the task reached its task
duration. For example, if this property is set to `PT1H`, the task duration is
set to `PT1H` and the supervisor creates a task at `2016-01-01T12:00Z`, Druid
drops messages with timestamps later than `2016-01-01T14:00Z`. Tasks sometimes
run past their task duration, such as in cases of supervisor failover. Setting
`earlyMessageRejectionPe [...]
+|`autoScalerConfig`|Object|Defines auto scaling behavior for Kafka ingest
tasks. See [Task autoscaler properties](#task-autoscaler-properties).|No|null|
+|`idleConfig`|Object|Defines how and when the Kafka supervisor can become
idle. See [Idle supervisor configuration](#idle-supervisor-configuration) for
more details.|No|null|
+
+### Task autoscaler properties
+
+The following table outlines the configuration options for `autoScalerConfig`:
+
+|Property|Description|Required|Default|
+|--------|-----------|--------|-------|
+|`enableTaskAutoScaler`|Enable or disable autoscaling. `false` or blank
disables the `autoScaler` even when `autoScalerConfig` is not null.|No|`false`|
+|`taskCountMax`|Maximum number of ingestion tasks. Set `taskCountMax >=
taskCountMin`. If `taskCountMax > {numKafkaPartitions}`, Druid only scales
reading tasks up to the `{numKafkaPartitions}`. In this case, `taskCountMax` is
ignored.|Yes||
+|`taskCountMin`|Minimum number of ingestion tasks. When you enable the
autoscaler, Druid ignores the value of `taskCount` in `ioConfig` and starts
with the `taskCountMin` number of tasks.|Yes||
+|`minTriggerScaleActionFrequencyMillis`|Minimum time interval between two
scale actions.|No|600000|
+|`autoScalerStrategy`|The algorithm of `autoScaler`. Only supports `lagBased`.
See [Lag based autoscaler strategy related
properties](#lag-based-autoscaler-strategy-related-properties) for
details.|No|`lagBased`|
+
+### Lag based autoscaler strategy related properties
+
+The following table outlines the configuration options for
`autoScalerStrategy`:
+
+|Property|Description|Required|Default|
+|--------|-----------|--------|-------|
+|`lagCollectionIntervalMillis`|The time period during which Druid collects lag
metric points.|No|30000|
+|`lagCollectionRangeMillis`|The total time window of lag collection. Use with
`lagCollectionIntervalMillis` to specify the intervals at which to collect lag
metric points.|No|600000|
+|`scaleOutThreshold`|The threshold of scale out action.|No|6000000|
+|`triggerScaleOutFractionThreshold`|Enables scale out action if
`triggerScaleOutFractionThreshold` percent of lag points is higher than
`scaleOutThreshold`.|No|0.3|
+|`scaleInThreshold`|The threshold of scale in action.|No|1000000|
+|`triggerScaleInFractionThreshold`|Enables scale in action if
`triggerScaleInFractionThreshold` percent of lag points is lower than
`scaleOutThreshold`.|No|0.9|
+|`scaleActionStartDelayMillis`|The number of milliseconds to delay after the
supervisor starts before the first scale logic check.|No|300000|
+|`scaleActionPeriodMillis`|The frequency in milliseconds to check if a scale
action is triggered.|No|60000|
+|`scaleInStep`|The number of tasks to reduce at once when scaling down.|No|1|
+|`scaleOutStep`|The number of tasks to add at once when scaling out.|No|2|
+
+### Ingesting from multiple topics
+
+To ingest data from multiple topics, you have to set `topicPattern` in the
supervisor I/O configuration and not set `topic`.
+You can pass multiple topics as a regex pattern as the value for
`topicPattern` in the I/O configuration. For example, to
+ingest data from clicks and impressions, set `topicPattern` to
`clicks|impressions` in the I/O configuration.
+Similarly, you can use `metrics-.*` as the value for `topicPattern` if you
want to ingest from all the topics that
+start with `metrics-`. If new topics are added to the cluster that match the
regex, Druid automatically starts
+ingesting from those new topics. A topic name that only matches partially such
as `my-metrics-12` will not be
+included for ingestion. If you enable multi-topic ingestion for a datasource,
downgrading to a version older than
+28.0.0 will cause the ingestion for that datasource to fail.
+
+When ingesting data from multiple topics, partitions are assigned based on the
hashcode of the topic name and the
+id of the partition within that topic. The partition assignment might not be
uniform across all the tasks. It's also
+assumed that partitions across individual topics have similar load. It is
recommended that you have a higher number of
+partitions for a high load topic and a lower number of partitions for a low
load topic. Assuming that you want to
+ingest from both high and low load topic in the same supervisor.
-| Property | Description | Required |
-| ------------- | ------------- | ------------- |
-| `enabled` | If `true`, Kafka supervisor will become idle if there is no data
on input stream/topic for some time. | no (default == false) |
-| `inactiveAfterMillis` | Supervisor is marked as idle if all existing data
has been read from input topic and no new data has been published for
`inactiveAfterMillis` milliseconds. | no (default == `600_000`) |
+## Idle supervisor configuration
:::info
- When the supervisor enters the idle state, no new tasks will be launched
subsequent to the completion of the currently executing tasks. This strategy
may lead to reduced costs for cluster operators while using topics that get
sporadic data.
+ Note that idle state transitioning is currently designated as experimental.
:::
-The following example demonstrates supervisor spec with `lagBased` autoScaler
and idle config enabled:
+|Property|Description|Required|
+|--------|-----------|--------|
+|`enabled`|If `true`, the supervisor becomes idle if there is no data on input
stream/topic for some time.|No|`false`|
+|`inactiveAfterMillis`|The supervisor becomes idle if all existing data has
been read from input topic and no new data has been published for
`inactiveAfterMillis` milliseconds.|No|`600_000`|
+
+When the supervisor enters the idle state, no new tasks are launched
subsequent to the completion of the currently executing tasks. This strategy
may lead to reduced costs for cluster operators while using topics that get
sporadic data.
+
+The following example demonstrates supervisor spec with `lagBased` autoscaler
and idle configuration enabled:
+
```json
{
"type": "kafka",
@@ -141,29 +166,13 @@ The following example demonstrates supervisor spec with
`lagBased` autoScaler an
}
}
```
-## Ingesting from multiple topics
-To ingest data from multiple topics, you have to set `topicPattern` in the
supervisor IO config and not set `topic`.
-Multiple topics can be passed as a regex pattern as the value for
`topicPattern` in the IO config. For example, to
-ingest data from clicks and impressions, you will set `topicPattern` to
`clicks|impressions` in the IO config.
-Similarly, you can use `metrics-.*` as the value for `topicPattern` if you
want to ingest from all the topics that
-start with `metrics-`. If new topics are added to the cluster that match the
regex, Druid will automatically start
-ingesting from those new topics. A topic name that only matches partially such
as `my-metrics-12` will not be
-included for ingestion. If you enable multi-topic ingestion for a datasource,
downgrading to a version older than
-28.0.0 will cause the ingestion for that datasource to fail.
-
-When ingesting data from multiple topics, partitions are assigned based on the
hashcode of the topic name and the
-id of the partition within that topic. The partition assignment might not be
uniform across all the tasks. It's also
-assumed that partitions across individual topics have similar load. It is
recommended that you have a higher number of
-partitions for a high load topic and a lower number of partitions for a low
load topic. Assuming that you want to
-ingest from both high and low load topic in the same supervisor.
-
-## More on consumerProperties
+## Consumer properties
Consumer properties must contain a property `bootstrap.servers` with a list of
Kafka brokers in the form: `<BROKER_1>:<PORT_1>,<BROKER_2>:<PORT_2>,...`.
By default, `isolation.level` is set to `read_committed`. If you use older
versions of Kafka servers without transactions support or don't want Druid to
consume only committed transactions, set `isolation.level` to
`read_uncommitted`.
-In some cases, you may need to fetch consumer properties at runtime. For
example, when `bootstrap.servers` is not known upfront, or is not static. To
enable SSL connections, you must provide passwords for `keystore`, `truststore`
and `key` secretly. You can provide configurations at runtime with a dynamic
config provider implementation like the environment variable config provider
that comes with Druid. For more information, see
[DynamicConfigProvider](../../operations/dynamic-config-pro [...]
+In some cases, you may need to fetch consumer properties at runtime. For
example, when `bootstrap.servers` is not known upfront, or is not static. To
enable SSL connections, you must provide passwords for `keystore`, `truststore`
and `key` secretly. You can provide configurations at runtime with a dynamic
config provider implementation like the environment variable config provider
that comes with Druid. For more information, see [Dynamic config
provider](../../operations/dynamic-config-p [...]
For example, if you are using SASL and SSL with Kafka, set the following
environment variables for the Druid user on the machines running the Overlord
and the Peon services:
@@ -186,16 +195,17 @@ export SSL_TRUSTSTORE_PASSWORD=mysecrettruststorepassword
}
}
```
-Verify that you've changed the values for all configurations to match your own
environment. You can use the environment variable config provider syntax in
the **Consumer properties** field on the **Connect tab** in the **Load Data**
UI in the web console. When connecting to Kafka, Druid replaces the environment
variables with their corresponding values.
-Note: You can provide SSL connections with [Password
Provider](../../operations/password-provider.md) interface to define the
`keystore`, `truststore`, and `key`, but this feature is deprecated.
+Verify that you've changed the values for all configurations to match your own
environment. You can use the environment variable config provider syntax in the
**Consumer properties** field on the **Connect tab** in the **Load Data** UI in
the web console. When connecting to Kafka, Druid replaces the environment
variables with their corresponding values.
+
+You can provide SSL connections with [Password
provider](../../operations/password-provider.md) interface to define the
`keystore`, `truststore`, and `key`, but this feature is deprecated.
## Specifying data format
-Kafka indexing service supports both
[`inputFormat`](../../ingestion/data-formats.md#input-format) and
[`parser`](../../ingestion/data-formats.md#parser) to specify the data format.
+The Kafka indexing service supports both
[`inputFormat`](../../ingestion/data-formats.md#input-format) and
[`parser`](../../ingestion/data-formats.md#parser) to specify the data format.
Use the `inputFormat` to specify the data format for Kafka indexing service
unless you need a format only supported by the legacy `parser`.
-Supported `inputFormat`s include:
+Druid supports the following input formats:
- `csv`
- `tsv`
@@ -207,62 +217,45 @@ Supported `inputFormat`s include:
For more information, see [Data formats](../../ingestion/data-formats.md). You
can also read [`thrift`](../extensions-contrib/thrift.md) formats using
`parser`.
-<a name="tuningconfig"></a>
-
-## KafkaSupervisorTuningConfig
-
-The `tuningConfig` is optional and default parameters will be used if no
`tuningConfig` is specified.
-
-| Field | Type | Description
[...]
-|-----------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| `type` | String | The indexing task type,
this should always be `kafka`.
[...]
-| `maxRowsInMemory` | Integer | The number of rows to
aggregate before persisting. This number is the post-aggregation rows, so it is
not equivalent to the number of input events, but the number of aggregated rows
that those events result in. This is used to manage the required JVM heap size.
Maximum heap memory usage for indexing scales with `maxRowsInMemory` * (2 +
`maxPendingPersists`). Normally user does not need to set this, but depending
on the nature of data [...]
-| `maxBytesInMemory` | Long | The number of bytes to
aggregate in heap memory before persisting. This is based on a rough estimate
of memory usage and not actual usage. Normally this is computed internally and
user does not need to set it. The maximum heap memory usage for indexing is
`maxBytesInMemory` * (2 + `maxPendingPersists`).
[...]
-| `maxRowsPerSegment` | Integer | The number of rows to
aggregate into a segment; this number is post-aggregation rows. Handoff will
happen either if `maxRowsPerSegment` or `maxTotalRows` is hit or every
`intermediateHandoffPeriod`, whichever happens earlier.
[...]
-| `maxTotalRows` | Long | The number of rows to
aggregate across all segments; this number is post-aggregation rows. Handoff
will happen either if `maxRowsPerSegment` or `maxTotalRows` is hit or every
`intermediateHandoffPeriod`, whichever happens earlier.
[...]
-| `intermediatePersistPeriod` | ISO8601 Period | The period that
determines the rate at which intermediate persists occur.
[...]
-| `maxPendingPersists` | Integer | Maximum number of
persists that can be pending but not started. If this limit would be exceeded
by a new intermediate persist, ingestion will block until the currently-running
persist finishes. Maximum heap memory usage for indexing scales with
`maxRowsInMemory` * (2 + `maxPendingPersists`).
[...]
-| `indexSpec` | Object | Tune how data is
indexed. See [IndexSpec](#indexspec) for more information.
[...]
-| `indexSpecForIntermediatePersists`| | Defines segment storage
format options to be used at indexing time for intermediate persisted temporary
segments. This can be used to disable dimension/metric compression on
intermediate segments to reduce memory required for final merging. However,
disabling compression on intermediate segments might increase page cache use
while they are used before getting merged into final segment published, see
[IndexSpec](#indexspec) for possib [...]
-| `reportParseExceptions` | Boolean | *DEPRECATED*. If true,
exceptions encountered during parsing will be thrown and will halt ingestion;
if false, unparseable rows and fields will be skipped. Setting
`reportParseExceptions` to true will override existing configurations for
`maxParseExceptions` and `maxSavedParseExceptions`, setting
`maxParseExceptions` to 0 and limiting `maxSavedParseExceptions` to no more
than 1. [...]
-| `handoffConditionTimeout` | Long | Number of milliseconds
to wait for segment handoff. Set to a value >= 0, where 0 means to wait
indefinitely.
[...]
-| `resetOffsetAutomatically` | Boolean | Controls behavior when
Druid needs to read Kafka messages that are no longer available (i.e. when
`OffsetOutOfRangeException` is encountered).<br/><br/>If false, the exception
will bubble up, which will cause your tasks to fail and ingestion to halt. If
this occurs, manual intervention is required to correct the situation;
potentially using the [Reset Supervisor
API](../../api-reference/supervisor-api.md). This mode is useful for pro [...]
-| `workerThreads` | Integer | The number of threads
that the supervisor uses to handle requests/responses for worker tasks, along
with any other internal asynchronous operation.
[...]
-| `chatRetries` | Integer | The number of times
HTTP requests to indexing tasks will be retried before considering tasks
unresponsive.
[...]
-| `httpTimeout` | ISO8601 Period | How long to wait for a
HTTP response from an indexing task.
[...]
-| `shutdownTimeout` | ISO8601 Period | How long to wait for
the supervisor to attempt a graceful shutdown of tasks before exiting.
[...]
-| `offsetFetchPeriod` | ISO8601 Period | How often the
supervisor queries Kafka and the indexing tasks to fetch current offsets and
calculate lag. If the user-specified value is below the minimum value (`PT5S`),
the supervisor ignores the value and uses the minimum value instead.
[...]
-| `segmentWriteOutMediumFactory` | Object | Segment write-out
medium to use when creating segments. See below for more information.
[...]
-| `intermediateHandoffPeriod` | ISO8601 Period | How often the tasks
should hand off segments. Handoff will happen either if `maxRowsPerSegment` or
`maxTotalRows` is hit or every `intermediateHandoffPeriod`, whichever happens
earlier.
[...]
-| `logParseExceptions` | Boolean | If true, log an error
message when a parsing exception occurs, containing information about the row
where the error occurred.
[...]
-| `maxParseExceptions` | Integer | The maximum number of
parse exceptions that can occur before the task halts ingestion and fails.
Overridden if `reportParseExceptions` is set.
[...]
-| `maxSavedParseExceptions` | Integer | When a parse exception
occurs, Druid can keep track of the most recent parse exceptions.
`maxSavedParseExceptions` limits how many exception instances will be saved.
These saved exceptions will be made available after the task finishes in the
[task completion report](../../ingestion/tasks.md#task-reports). Overridden if
`reportParseExceptions` is set.
[...]
-
-#### IndexSpec
-
-|Field|Type|Description|Required|
-|-----|----|-----------|--------|
-|bitmap|Object|Compression format for bitmap indexes. Should be a JSON object.
See [Bitmap types](#bitmap-types) below for options.|no (defaults to Roaring)|
-|dimensionCompression|String|Compression format for dimension columns. Choose
from `LZ4`, `LZF`, `ZSTD` or `uncompressed`.|no (default == `LZ4`)|
-|metricCompression|String|Compression format for primitive type metric
columns. Choose from `LZ4`, `LZF`, `ZSTD`, `uncompressed` or `none`.|no
(default == `LZ4`)|
-|longEncoding|String|Encoding format for metric and dimension columns with
type long. Choose from `auto` or `longs`. `auto` encodes the values using
offset or lookup table depending on column cardinality, and store them with
variable size. `longs` stores the value as is with 8 bytes each.|no (default ==
`longs`)|
-
-##### Bitmap types
-
-For Roaring bitmaps:
-
-|Field|Type|Description|Required|
-|-----|----|-----------|--------|
-|`type`|String|Must be `roaring`.|yes|
-
-For Concise bitmaps:
-
-|Field|Type|Description|Required|
-|-----|----|-----------|--------|
-|`type`|String|Must be `concise`.|yes|
-
-#### SegmentWriteOutMediumFactory
-
-|Field|Type|Description|Required|
-|-----|----|-----------|--------|
-|`type`|String|See [Additional Peon Configuration:
SegmentWriteOutMediumFactory](../../configuration/index.md#segmentwriteoutmediumfactory)
for explanation and available options.|yes|
+## Supervisor tuning configuration
+
+The `tuningConfig` object is optional. If you don't specify the `tuningConfig`
object, Druid uses the default configuration settings.
+
+|Property|Type|Description|Required|Default|
+|--------|----|-----------|--------|-------|
+|`type`|String|The indexing task type. This should always be `kafka`.|Yes||
+|`maxRowsInMemory`|Integer|The number of rows to aggregate before persisting.
This number represents the post-aggregation rows. It is not equivalent to the
number of input events, but the resulting number of aggregated rows. Druid uses
`maxRowsInMemory` to manage the required JVM heap size. The maximum heap memory
usage for indexing scales is `maxRowsInMemory * (2 + maxPendingPersists)`.
Normally, you do not need to set this, but depending on the nature of data, if
rows are short in term [...]
+|`maxBytesInMemory`|Long|The number of bytes to aggregate in heap memory
before persisting. This is based on a rough estimate of memory usage and not
actual usage. Normally, this is computed internally. The maximum heap memory
usage for indexing is `maxBytesInMemory * (2 +
maxPendingPersists)`.|No|One-sixth of max JVM memory|
+|`skipBytesInMemoryOverheadCheck`|Boolean|The calculation of
`maxBytesInMemory` takes into account overhead objects created during ingestion
and each intermediate persist. To exclude the bytes of these overhead objects
from the `maxBytesInMemory` check, set `skipBytesInMemoryOverheadCheck` to
`true`.|No|`false`|
+|`maxRowsPerSegment`|Integer|The number of rows to store in a segment. This
number is post-aggregation rows. Handoff occurs when `maxRowsPerSegment` or
`maxTotalRows` is reached or every `intermediateHandoffPeriod`, whichever
happens first.|No|5000000|
+|`maxTotalRows`|Long|The number of rows to aggregate across all segments; this
number is post-aggregation rows. Handoff happens either if `maxRowsPerSegment`
or `maxTotalRows` is reached or every `intermediateHandoffPeriod`, whichever
happens earlier.|No|20000000|
+|`intermediateHandoffPeriod`|ISO 8601 period|The period that determines how
often tasks hand off segments. Handoff occurs if `maxRowsPerSegment` or
`maxTotalRows` is reached or every `intermediateHandoffPeriod`, whichever
happens first.|No|P2147483647D|
+|`intermediatePersistPeriod`|ISO 8601 period|The period that determines the
rate at which intermediate persists occur.|No|PT10M|
+|`maxPendingPersists`|Integer|Maximum number of persists that can be pending
but not started. If a new intermediate persist exceeds this limit, Druid blocks
ingestion until the currently running persist finishes. One persist can be
running concurrently with ingestion, and none can be queued up. The maximum
heap memory usage for indexing scales is `maxRowsInMemory * (2 +
maxPendingPersists)`.|No|0|
+|`indexSpec`|Object|Defines how Druid indexes the data. See
[IndexSpec](#indexspec) for more information.|No||
+|`indexSpecForIntermediatePersists`|Object|Defines segment storage format
options to use at indexing time for intermediate persisted temporary segments.
You can use `indexSpecForIntermediatePersists` to disable dimension/metric
compression on intermediate segments to reduce memory required for final
merging. However, disabling compression on intermediate segments might increase
page cache use while they are used before getting merged into final segment
published. See [IndexSpec](#indexsp [...]
+|`reportParseExceptions`|Boolean|DEPRECATED. If `true`, Druid throws
exceptions encountered during parsing causing ingestion to halt. If `false`,
Druid skips unparseable rows and fields. Setting `reportParseExceptions` to
`true` overrides existing configurations for `maxParseExceptions` and
`maxSavedParseExceptions`, setting `maxParseExceptions` to 0 and limiting
`maxSavedParseExceptions` to not more than 1.|No|`false`|
+|`handoffConditionTimeout`|Long|Number of milliseconds to wait for segment
handoff. Set to a value >= 0, where 0 means to wait indefinitely.|No|900000 (15
minutes)|
+|`resetOffsetAutomatically`|Boolean|Controls behavior when Druid needs to read
Kafka messages that are no longer available, when `offsetOutOfRangeException`
is encountered.<br/>If `false`, the exception bubbles up causing tasks to fail
and ingestion to halt. If this occurs, manual intervention is required to
correct the situation, potentially using the [Reset Supervisor
API](../../api-reference/supervisor-api.md). This mode is useful for
production, since it will make you aware of issues [...]
+|`workerThreads`|Integer|The number of threads that the supervisor uses to
handle requests/responses for worker tasks, along with any other internal
asynchronous operation.|No|`min(10, taskCount)`|
+|`chatAsync`|Boolean|If `true`, use asynchronous communication with indexing
tasks, and ignore the `chatThreads` parameter. If `false`, use synchronous
communication in a thread pool of size `chatThreads`.|No|`true`|
+|`chatThreads`|Integer|The number of threads to use for communicating with
indexing tasks. Ignored if `chatAsync` is `true`.|No|`min(10, taskCount *
replicas)`|
+|`chatRetries`|Integer|The number of times HTTP requests to indexing tasks are
retried before considering tasks unresponsive.|No|8|
+|`httpTimeout`| ISO 8601 period|The period of time to wait for a HTTP response
from an indexing task.|No|PT10S|
+|`shutdownTimeout`|ISO 8601 period|The period of time to wait for the
supervisor to attempt a graceful shutdown of tasks before exiting.|No|PT80S|
+|`offsetFetchPeriod`|ISO 8601 period|Determines how often the supervisor
queries Kafka and the indexing tasks to fetch current offsets and calculate
lag. If the user-specified value is below the minimum value of `PT5S`, the
supervisor ignores the value and uses the minimum value instead.|No|PT30S|
+|`segmentWriteOutMediumFactory`|Object|The segment write-out medium to use
when creating segments. See [Additional Peon configuration:
SegmentWriteOutMediumFactory](../../configuration/index.md#segmentwriteoutmediumfactory)
for explanation and available options.|No|If not specified, Druid uses the
value from `druid.peon.defaultSegmentWriteOutMediumFactory.type`.|
+|`logParseExceptions`|Boolean|If `true`, Druid logs an error message when a
parsing exception occurs, containing information about the row where the error
occurred.|No|`false`|
+|`maxParseExceptions`|Integer|The maximum number of parse exceptions that can
occur before the task halts ingestion and fails. Overridden if
`reportParseExceptions` is set.|No|unlimited|
+|`maxSavedParseExceptions`|Integer|When a parse exception occurs, Druid keeps
track of the most recent parse exceptions. `maxSavedParseExceptions` limits the
number of saved exception instances. These saved exceptions are available after
the task finishes in the [task completion
report](../../ingestion/tasks.md#task-reports). Overridden if
`reportParseExceptions` is set.|No|0|
+
+### IndexSpec
+
+The following table outlines the configuration options for `indexSpec`:
+
+|Property|Type|Description|Required|Default|
+|--------|----|-----------|--------|-------|
+|`bitmap`|Object|Compression format for bitmap indexes. Druid supports roaring
and concise bitmap types.|No|Roaring|
+|`dimensionCompression`|String|Compression format for dimension columns.
Choose from `LZ4`, `LZF`, `ZSTD` or `uncompressed`.|No|`LZ4`|
+|`metricCompression`|String|Compression format for primitive type metric
columns. Choose from `LZ4`, `LZF`, `ZSTD`, `uncompressed` or `none`.|No|`LZ4`|
+|`longEncoding`|String|Encoding format for metric and dimension columns with
type long. Choose from `auto` or `longs`. `auto` encodes the values using
offset or lookup table depending on column cardinality, and store them with
variable size. `longs` stores the value as is with 8 bytes each.|No|`longs`|
\ No newline at end of file
diff --git a/docs/ingestion/ingestion-spec.md b/docs/ingestion/ingestion-spec.md
index d0d974ca22..bc02faf200 100644
--- a/docs/ingestion/ingestion-spec.md
+++ b/docs/ingestion/ingestion-spec.md
@@ -503,7 +503,7 @@ is:
|skipBytesInMemoryOverheadCheck|The calculation of maxBytesInMemory takes into
account overhead objects created during ingestion and each intermediate
persist. Setting this to true can exclude the bytes of these overhead objects
from maxBytesInMemory check.|false|
|indexSpec|Defines segment storage format options to use at indexing time.|See
[`indexSpec`](#indexspec) for more information.|
|indexSpecForIntermediatePersists|Defines segment storage format options to
use at indexing time for intermediate persisted temporary segments.|See
[`indexSpec`](#indexspec) for more information.|
-|Other properties|Each ingestion method has its own list of additional tuning
properties. See the documentation for each method for a full list: [Kafka
indexing
service](../development/extensions-core/kafka-supervisor-reference.md#tuningconfig),
[Kinesis indexing
service](../development/extensions-core/kinesis-ingestion.md#supervisor-tuning-configuration),
[Native batch](native-batch.md#tuningconfig), and
[Hadoop-based](hadoop.md#tuningconfig).||
+|Other properties|Each ingestion method has its own list of additional tuning
properties. See the documentation for each method for a full list: [Kafka
indexing
service](../development/extensions-core/kafka-supervisor-reference.md#supervisor-tuning-configuration),
[Kinesis indexing
service](../development/extensions-core/kinesis-ingestion.md#supervisor-tuning-configuration),
[Native batch](native-batch.md#tuningconfig), and
[Hadoop-based](hadoop.md#tuningconfig).||
### `indexSpec`
diff --git a/docs/tutorials/tutorial-jupyter-docker.md
b/docs/tutorials/tutorial-jupyter-docker.md
index 1978caebd0..a1091f0ab7 100644
--- a/docs/tutorials/tutorial-jupyter-docker.md
+++ b/docs/tutorials/tutorial-jupyter-docker.md
@@ -111,7 +111,7 @@ If Druid is running local to the same machine as Jupyter,
open the tutorial and
host = "host.docker.internal"
```
-To enable Druid to ingest data from Kafka within the Docker Compose
environment, update the `bootstrap.servers` property in the Kafka ingestion
spec to `localhost:9094` before ingesting. For reference, see [more on consumer
properties](../development/extensions-core/kafka-supervisor-reference.md#more-on-consumerproperties).
+To enable Druid to ingest data from Kafka within the Docker Compose
environment, update the `bootstrap.servers` property in the Kafka ingestion
spec to `localhost:9094` before ingesting. For reference, see [Consumer
properties](../development/extensions-core/kafka-supervisor-reference.md#consumer-properties).
### Update image from Docker Hub
diff --git a/web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx
b/web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx
index 1c961c512b..3e72cc24fe 100644
--- a/web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx
+++ b/web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx
@@ -911,7 +911,7 @@ export function getIoConfigFormFields(ingestionComboType:
IngestionComboType): F
<ExternalLink
href={`${getLink(
'DOCS',
-
)}/development/extensions-core/kafka-ingestion#kafkasupervisorioconfig`}
+
)}/development/extensions-core/kafka-ingestion#supervisor-io-configuration`}
>
consumerProperties
</ExternalLink>
@@ -961,7 +961,7 @@ export function getIoConfigFormFields(ingestionComboType:
IngestionComboType): F
<ExternalLink
href={`${getLink(
'DOCS',
-
)}/development/extensions-core/kafka-ingestion#kafkasupervisorioconfig`}
+
)}/development/extensions-core/kafka-ingestion#supervisor-io-configuration`}
>
consumerProperties
</ExternalLink>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
