xvrl commented on a change in pull request #11630:
URL: https://github.com/apache/druid/pull/11630#discussion_r718726242
##########
File path: docs/ingestion/data-formats.md
##########
@@ -151,6 +151,51 @@ Be sure to change the `delimiter` to the appropriate
delimiter for your data. Li
}
```
+### KAFKA
+
+The `inputFormat` to load complete kafka record including header, key and
value. An example is:
+
+```json
+"ioConfig": {
+ "inputFormat": {
+ "type": "kafka",
+ "headerLabelPrefix": "kafka.header.",
+ "timestampColumnName": "kafka.timestamp",
+ "keyColumnName": "kafka.key",
+ "headerFormat":
+ {
+ "type": "string"
+ },
+ "keyFormat":
+ {
+ "type": "json"
+ },
+ "valueFormat":
+ {
+ "type": "json"
+ }
+ },
+ ...
+}
+```
+
+The KAFKA `inputFormat` has the following components:
+
+| Field | Type | Description | Required |
+|-------|------|-------------|----------|
+| type | String | This should say `kafka`. | yes |
+| headerLabelPrefix | String | A custom label prefix for all the header
columns. | no (default = "kafka.header.") |
+| timestampColumnName | String | Specifies the name of the column for the
kafka record's timestamp.| no (default = "kafka.timestamp") |
+| keyColumnName | String | Specifies the name of the column for the kafka
record's key.| no (default = "kafka.key") |
+| headerFormat | Object | headerFormat specifies how to parse the kafka
headers. Current supported type is "string". | no |
+| keyFormat | Object | keyFormat can be any existing inputFormat to parse the
kafka key. See [the below
section](../development/extensions-core/kafka-ingestion.md#specifying-data-format)
for details about specifying the input format. | no |
Review comment:
we should document the type to be "InputFormat" and link to the input
format sections in the docs.
We should also document the behavior that this will only process the first
entry of the input format
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
