PublishKafka_2_0
描述:
Sends the contents of a FlowFile as a message to Apache Kafka using the Kafka 2.0 Producer API.The messages to send may be individual FlowFiles or may be delimited, using a user-specified delimiter, such as a new-line. The complementary NiFi processor for fetching messages is ConsumeKafka_2_0.
标签:
Apache, Kafka, Put, Send, Message, PubSub, 2.0
参数:
如下列表中，必填参数则标识为加粗. 其他未加粗参数，则表示为可选参数。表中同时提到参数默认值设置, 并且 参数还支持 表达式语言.
| 名字 | 默认值 | 允许值列表 | 描述 |
|---|---|---|---|
| Kafka Brokers | localhost:9092 | A comma-separated list of known Kafka Brokers in the format <host>:<port>支持表达式语言 (仅支持变量) | |
| Security Protocol | PLAINTEXT | - PLAINTEXT  - SSL - SASL_PLAINTEXT - SASL_SSL | Protocol used to communicate with brokers. Corresponds to Kafka's 'security.protocol' property. |
| 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 Credentials Service | 控制器服务API: KerberosCredentialsService 实现: KeytabCredentialsService | Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos | |
| 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. | |
| Topic Name | The name of the Kafka Topic to publish to. 支持表达式语言 (支持流属性和变量) | ||
| 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. |
| 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." |
| 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. | |
| Kafka Key | The Key to use for the Message. If not specified, the flow file attribute 'kafka.key' is used as the message key, if it is present.Beware that setting Kafka key and demarcating at the same time may potentially lead to many Kafka messages with the same key.Normally this is not a problem as Kafka does not enforce or assume message and key uniqueness. Still, setting the demarcator and Kafka key at the same time poses a risk of data loss on Kafka. During a topic compaction on Kafka, messages will be deduplicated based on this key. 支持表达式语言 (支持流属性和变量) | ||
| Key Attribute Encoding | UTF-8 Encoded | - UTF-8 Encoded - Hex Encoded | FlowFiles that are emitted have an attribute named 'kafka.key'. This property dictates how the value of the attribute should be encoded. |
| Message Demarcator | Specifies the string (interpreted as UTF-8) to use for demarcating multiple messages within a single FlowFile. If not specified, the entire content of the FlowFile will be used as a single message. If specified, the contents of the FlowFile will be split on this delimiter and each section sent as a separate Kafka message. To enter special character such as 'new line' use CTRL+Enter or Shift+Enter, depending on your OS. 支持表达式语言 (支持流属性和变量) | ||
| 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. If the <Message Demarcator> Property is not set, this will always be 1, but if the Property is set, it may be greater than 1. |
状态管理:
该组件不保存状态。
限制:
该组件没有限制
输入流要求:
组件必须提供输入流。
系统资源考量:
未提供。