Supports Expression Language: true (will be evaluated using variable registry only)Topic Name | | | The name of the Kafka Topic to publish to. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Record Reader | | Controller Service API: RecordReaderFactory Implementations: JsonPathReader AvroReader XMLReader WindowsEventLogReader ReaderLookup Syslog5424Reader GrokReader ScriptedReader CSVReader SyslogReader ParquetReader JsonTreeReader CEFReader | The Record Reader to use for incoming FlowFiles |
Record Writer | | Controller Service API: RecordSetWriterFactory Implementations: AvroRecordSetWriter ScriptedRecordSetWriter JsonRecordSetWriter ParquetRecordSetWriter RecordSetWriterLookup FreeFormTextRecordSetWriter XMLRecordSetWriter CSVRecordSetWriter | The Record Writer to use in order to serialize the data before sending to Kafka |
Use Transactions | true | | 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." |
Failure Strategy | Route to Failure | - Route to Failure
- Rollback
| Dictates how the processor handles a FlowFile if it is unable to publish the data to Kafka |
Transactional Id Prefix | | | When Use Transaction is set to true, KafkaProducer config 'transactional.id' will be a generated UUID and will be prefixed with this string. Supports Expression Language: true (will be evaluated using variable registry only) |
Delivery Guarantee | all | - 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. |
SASL Mechanism | GSSAPI | - GSSAPI
- PLAIN
- SCRAM-SHA-256
- SCRAM-SHA-512
| The SASL mechanism to use for authentication. Corresponds to Kafka's 'sasl.mechanism' property. |
Kerberos Credentials Service | | Controller Service API: KerberosCredentialsService Implementation: KeytabCredentialsService | Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos |
Kerberos Service Name | | | The service name that matches the primary name of the Kafka server configured in the broker JAAS file.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. Supports Expression Language: true (will be evaluated using variable registry only) |
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. Supports Expression Language: true (will be evaluated using variable registry only) |
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.
This property requires exactly one file to be provided..
Supports Expression Language: true (will be evaluated using variable registry only) |
Username | | | The username when the SASL Mechanism is PLAIN or SCRAM-SHA-256/SCRAM-SHA-512 Supports Expression Language: true (will be evaluated using variable registry only) |
Password | | | The password for the given username when the SASL Mechanism is PLAIN or SCRAM-SHA-256/SCRAM-SHA-512 Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only) |
Token Auth | false | | When SASL Mechanism is SCRAM-SHA-256 or SCRAM-SHA-512, this property indicates if token authentication should be used. |
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 (will be evaluated using flow file attributes and variable registry) |
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 Supports Expression Language: true (will be evaluated using variable registry only) |
Partitioner class | org.apache.kafka.clients.producer.internals.DefaultPartitioner | - RoundRobinPartitioner
- DefaultPartitioner
- RecordPath Partitioner
- Expression Language Partitioner
| Specifies which class to use to compute a partition id for a message. Corresponds to Kafka's 'partitioner.class' property. |
Partition | | | Specifies which Partition Records will go to. How this value is interpreted is dictated by the <Partitioner class> property. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Compression Type | none | | 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: http://kafka.apache.org/documentation.html#configuration. Supports Expression Language: true (will be evaluated using variable registry only) |
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.System Resource Considerations:
None specified.See Also:
PublishKafka_2_0, ConsumeKafka_2_0, ConsumeKafkaRecord_2_0