Description:
Sends the contents of a FlowFile as individual records to Apache Kafka using the Kafka 0.11.x Producer API. The contents of the FlowFile are expected to be record-oriented data that can be read by the configured Record Reader. Please note there are cases where the publisher can get into an indefinite stuck state. We are closely monitoring how this evolves in the Kafka community and will take advantage of those fixes as soon as we can. In the meantime, it is possible to enter states where the only resolution will be to restart the JVM NiFi runs on. The complementary NiFi processor for fetching messages is ConsumeKafka_0_11_Record.
Tags:
Apache, Kafka, Record, CSV, JSON, avro, logs, Put, Send, Message, PubSub, 0.11.x
Properties:
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
|
Name |
Default Value |
Allowable Values |
Description |
|
Kafka Brokers |
localhost:9092 |
A comma-separated list of known Kafka Brokers in the format <host>:<port> Supports Expression Language: true |
|
|
Topic Name |
The name of the Kafka Topic to publish to. Supports Expression Language: true |
||
|
Record Reader |
Controller Service API: RecordReaderFactory Implementations: CSVReader GrokReader AvroReader JsonTreeReader JsonPathReader ScriptedReader |
The Record Reader to use for incoming FlowFiles | |
|
Record Writer |
Controller Service API: RecordSetWriterFactory Implementations: JsonRecordSetWriter FreeFormTextRecordSetWriter AvroRecordSetWriter ScriptedRecordSetWriter CSVRecordSetWriter |
The Record Writer to use 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 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 |
0 |
* 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 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 |
Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService |
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. Supports Expression Language: true |
||
|
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, the FlowFile will be routed to 'failure'. | |
|
Max Metadata Wait Time |
5 secs |
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 Supports Expression Language: true |
|
| Partitioner class | org.apache.kafka.clients.producer.internals.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. |
Dynamic Properties:
Dynamic Properties allow the user to specify both the name and value of a property.
|
Name |
Value |
Description |
| 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: . |
Relationships:
|
Name |
Description |
| 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. |
Reads Attributes:
None specified.
Writes Attributes:
|
Name |
Description |
| 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. |
State management:
This component does not store state.
Restricted:
This component is not restricted.
Input requirement:
This component requires an incoming relationship.
See Also:
PublishKafka_0_11, ConsumeKafka_0_11, ConsumeKafkaRecord_0_11