PublishKafkaRecord_2_0
描述:
Sends the contents of a FlowFile as individual records to Apache Kafka using the Kafka 2.0 Producer API. The contents of the FlowFile are expected to be record-oriented data that can be read by the configured Record Reader. The complementary NiFi processor for fetching messages is ConsumeKafkaRecord_2_0.
标签:
Apache, Kafka, Record, csv, json, avro, logs, Put, Send, Message, PubSub, 2.0
参数:
如下列表中，必填参数则标识为加粗. 其他未加粗参数，则表示为可选参数。表中同时提到参数默认值设置, 并且 参数还支持 表达式语言.
| 名字 | 默认值 | 允许值列表 | 描述 |
|---|---|---|---|
| Kafka Brokers | localhost:9092 | A comma-separated list of known Kafka Brokers in the format <host>:<port>支持表达式语言 (仅支持变量) | |
| Topic Name | The name of the Kafka Topic to publish to. 支持表达式语言 (支持流属性和变量) | ||
| Record Reader | 控制器服务API: RecordReaderFactory 实现: ParquetReader GrokReader SyslogReader Syslog5424Reader CSVReader AvroReader JsonPathReader JsonTreeReader ScriptedReader XMLReader | The Record Reader to use for incoming FlowFiles | |
| Record Writer | 控制器服务API: RecordSetWriterFactory 实现: CSVRecordSetWriter FreeFormTextRecordSetWriter AvroRecordSetWriter JsonRecordSetWriter XMLRecordSetWriter ParquetRecordSetWriter ScriptedRecordSetWriter | The Record Writer to use in order to serialize the data before sending to Kafka | |
| Use Transactions | true | - true - false | Specifies whether or not NiFi should provide Transactional guarantees when communicating with Kafka. If there is a problem sending data to Kafka, and this property is set to false, then the messages that have already been sent to Kafka will continue on and be delivered to consumers. If this is set to true, then the Kafka transaction will be rolled back so that those messages are not available to consumers. Setting this to true requires that the <Delivery Guarantee> property be set to "Guarantee Replicated Delivery." |
| Delivery Guarantee | Best Effort | - Best Effort  - Guarantee Single Node Delivery - Guarantee Replicated Delivery | Specifies the requirement for guaranteeing that a message is sent to Kafka. Corresponds to Kafka's 'acks' property. |
| Attributes to Send as Headers (Regex) | A Regular Expression that is matched against all FlowFile attribute names. Any attribute whose name matches the regex will be added to the Kafka messages as a Header. If not specified, no FlowFile attributes will be added as headers. | ||
| Message Header Encoding | UTF-8 | For any attribute that is added as a message header, as configured via the <Attributes to Send as Headers> property, this property indicates the Character Encoding to use for serializing the headers. | |
| Security Protocol | PLAINTEXT | - PLAINTEXT - SSL - SASL_PLAINTEXT - SASL_SSL | Protocol used to communicate with brokers. Corresponds to Kafka's 'security.protocol' property. |
| Kerberos Credentials Service | 控制器服务API: KerberosCredentialsService 实现: KeytabCredentialsService | Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos | |
| Kerberos Service Name | The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. Corresponds to Kafka's 'security.protocol' property.It is ignored unless one of the SASL options of the <Security Protocol> are selected.支持表达式语言 (仅支持变量) | ||
| Kerberos Principal | The Kerberos principal that will be used to connect to brokers. If not set, it is expected to set a JAAS configuration file in the JVM properties defined in the bootstrap.conf file. This principal will be set into 'sasl.jaas.config' Kafka's property. 支持表达式语言 (仅支持变量) | ||
| Kerberos Keytab | The Kerberos keytab that will be used to connect to brokers. If not set, it is expected to set a JAAS configuration file in the JVM properties defined in the bootstrap.conf file. This principal will be set into 'sasl.jaas.config' Kafka's property. 支持表达式语言 (仅支持变量) | ||
| SSL Context Service | 控制器服务API: SSLContextService 实现: StandardRestrictedSSLContextService StandardSSLContextService | Specifies the SSL Context Service to use for communicating with Kafka. | |
| Message Key Field | The name of a field in the Input Records that should be used as the Key for the Kafka message. 支持表达式语言 (支持流属性和变量) | ||
| Max Request Size | 1 MB | The maximum size of a request in bytes. Corresponds to Kafka's 'max.request.size' property and defaults to 1 MB (1048576). | |
| Acknowledgment Wait Time | 5 secs | After sending a message to Kafka, this indicates the amount of time that we are willing to wait for a response from Kafka. If Kafka does not acknowledge the message within this time period, the FlowFile will be routed to 'failure'. | |
| Max Metadata Wait Time | 5 sec | The amount of time publisher will wait to obtain metadata or wait for the buffer to flush during the 'send' call before failing the entire 'send' call. Corresponds to Kafka's 'max.block.ms' property 支持表达式语言 (仅支持变量) | |
| Partitioner class | DefaultPartitioner | - RoundRobinPartitioner - DefaultPartitioner | Specifies which class to use to compute a partition id for a message. Corresponds to Kafka's 'partitioner.class' property. |
| Compression Type | none | - none - gzip - snappy - lz4 | This parameter allows you to specify the compression codec for all data generated by this producer. |
动态参数:
| 名字 | 值 | 描述 |
|---|---|---|
| The name of a Kafka configuration property. | The value of a given Kafka configuration property. | These properties will be added on the Kafka configuration after loading any provided configuration properties. In the event a dynamic property represents a property that was already set, its value will be ignored and WARN message logged. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration. 不支持表达式语言 |
连线:
| 名字 | 描述 |
|---|---|
| success | FlowFiles for which all content was sent to Kafka. |
| failure | Any FlowFile that cannot be sent to Kafka will be routed to this Relationship |
读取属性:
未提供。
写入属性:
| 名字 | 描述 |
|---|---|
| msg.count | The number of messages that were sent to Kafka for this FlowFile. This attribute is added only to FlowFiles that are routed to success. |
状态管理:
该组件不保存状态。
限制:
该组件没有限制
输入流要求:
组件必须提供输入流。
系统资源考量:
未提供。