ektravel commented on code in PR #14281:
URL: https://github.com/apache/druid/pull/14281#discussion_r1197947936
##########
docs/development/extensions-contrib/kafka-emitter.md:
##########
@@ -36,20 +36,28 @@ to monitor the status of your Druid cluster with this
extension.
All the configuration parameters for the Kafka emitter are under
`druid.emitter.kafka`.
-|property|description|required?|default|
-|--------|-----------|---------|-------|
-|`druid.emitter.kafka.bootstrap.servers`|Comma-separated Kafka broker.
(`[hostname:port],[hostname:port]...`)|yes|none|
-|`druid.emitter.kafka.metric.topic`|Kafka topic name for emitter's target to
emit service metric.|yes|none|
-|`druid.emitter.kafka.alert.topic`|Kafka topic name for emitter's target to
emit alert.|yes|none|
-|`druid.emitter.kafka.request.topic`|Kafka topic name for emitter's target to
emit request logs. If left empty then request logs will not be sent to the
Kafka topic.|no|none|
-|`druid.emitter.kafka.producer.config`|JSON formatted configuration which user
want to set additional properties to Kafka producer.|no|none|
-|`druid.emitter.kafka.clusterName`|Optional value to specify name of your
druid cluster. It can help make groups in your monitoring environment. |no|none|
+| property | description
| required? | default |
+|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-----------------------|
+| `druid.emitter.kafka.bootstrap.servers` | Comma-separated Kafka
broker. (`[hostname:port],[hostname:port]...`)
| yes | none |
+| `druid.emitter.kafka.event.types` | Comma-separated event
types. <br/>Choices: alerts, metrics, requests, segmentMetadata
| no | ["metrics", "alerts"] |
+| `druid.emitter.kafka.metric.topic` | Kafka topic name for
emitter's target to emit service metric. If `event.types` contains `metrics`,
this field cannot be left empty
| no | none |
+| `druid.emitter.kafka.alert.topic` | Kafka topic name for
emitter's target to emit alert. If `event.types` contains `alerts`, this field
cannot be left empty
| no | none |
+| `druid.emitter.kafka.request.topic` | Kafka topic name for
emitter's target to emit request logs. If `event.types` contains `requests`,
this field cannot be left empty
| no | none |
+| `druid.emitter.kafka.segmentMetadata.topic` | Kafka topic name for
emitter's target to emit segments related metadata. If `event.types` contains
`segmentMetadata`, this field cannot be left empty
| no | none |
+| `druid.emitter.kafka.segmentMetadata.topic.format` | Format in which segment
related metadata will be emitted. <br/>Choices: json, protobuf.<br/> If set to
`protobuf`, then segment metadata is emitted in `DruidSegmentEvent.proto`
format | no | json |
+| `druid.emitter.kafka.producer.config` | JSON formatted
configuration which user want to set additional properties to Kafka producer.
| no | none |
+| `druid.emitter.kafka.clusterName` | Optional value to
specify name of your druid cluster. It can help make groups in your monitoring
environment.
| no | none |
### Example
```
druid.emitter.kafka.bootstrap.servers=hostname1:9092,hostname2:9092
-druid.emitter.kafka.metric.topic=druid-metric
+druid.emitter.kafka.event.types=["alerts", "requests", "segmentMetadata"]
druid.emitter.kafka.alert.topic=druid-alert
+druid.emitter.kafka.request.topic=druid-request-logs
+druid.emitter.kafka.segmentMetadata.topic=druid-segment-metadata
+druid.emitter.kafka.segmentMetadata.topic.format=protobuf
druid.emitter.kafka.producer.config={"max.block.ms":10000}
```
+Whenever `druid.emitter.kafka.segmentMetadata.topic.format` field is updated,
it is recommended to also update `druid.emitter.kafka.segmentMetadata.topic`
to avoid the same topic from getting polluted with different formats of segment
metadata.
Review Comment:
```suggestion
When you update `druid.emitter.kafka.segmentMetadata.topic.format`, it is
recommended that you also update `druid.emitter.kafka.segmentMetadata.topic` to
avoid the same topic from getting polluted with different formats of segment
metadata.
```
--
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]
