-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Description
In documentation, tuningConfig configuration options are split into different ingestion task types, introducing potential hops between pages, and potentially giving conflicting information when a reader searches for a config option that is common across ingestion types and described differently.
Affected Version
0.22.0
Description
tuningConfigdocumentation is split across six pages:
https://druid.apache.org/docs/latest/ingestion/ingestion-spec.html#tuningconfig
https://druid.apache.org/docs/latest/ingestion/native-batch.html#tuningconfig
https://druid.apache.org/docs/latest/development/extensions-core/kafka-ingestion.html#kafkasupervisortuningconfig
https://druid.apache.org/docs/latest/development/extensions-core/kinesis-ingestion.html#tuningconfig
https://druid.apache.org/docs/latest/ingestion/hadoop.html#tuningconfig
https://druid.apache.org/docs/latest/configuration/index.html#automatic-compaction-tuningconfig
kafkaoptions are a subset of those forkinesis- 22 are common, with 8 unique to kinesis- When
hadoopis taken out of the equation, the number of config options that are common to all ingestion types jumps from 3 to 9 - Autocompation tuningConfig is, unlike other documentation, inside the Configuration Reference
Proposal
Based on the presumption that learners are interested in tuning options specific to their own ingestion source, create common pages, then vary by ingestion-specific, and isolate deprecated approaches.