Supports Expression Language: true (will be evaluated using variable registry only)Topic Name | topic | | | The name of the Kafka Topic to publish to. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Use Transactions | 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." |
Transactional Id Prefix | 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)
This Property is only considered if the [Use Transactions] Property has a value of "true". |
Message Demarcator | 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. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Failure Strategy | Failure Strategy | Route to Failure | - Route to Failure
- Rollback
| Specifies how the processor handles a FlowFile if it is unable to publish the data to Kafka |
Delivery Guarantee | acks | Guarantee Replicated Delivery | - 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) | attribute-name-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 | 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 | security.protocol | PLAINTEXT | - PLAINTEXT
- SSL
- SASL_PLAINTEXT
- SASL_SSL
| Security protocol used to communicate with brokers. Corresponds to Kafka Client security.protocol property |
SASL Mechanism | sasl.mechanism | GSSAPI | - GSSAPI
- PLAIN
- SCRAM-SHA-256
- SCRAM-SHA-512
| SASL mechanism used for authentication. Corresponds to Kafka Client sasl.mechanism property |
Kerberos Credentials Service | kerberos-credentials-service | | Controller Service API: KerberosCredentialsService Implementation: KeytabCredentialsService | Service supporting generalized credentials authentication with Kerberos |
Kerberos User Service | kerberos-user-service | | Controller Service API: SelfContainedKerberosUserService Implementations: KerberosKeytabUserService KerberosTicketCacheUserService | Service supporting user authentication with Kerberos |
Kerberos Service Name | sasl.kerberos.service.name | | | The service name that matches the primary name of the Kafka server configured in the broker JAAS configuration Supports Expression Language: true (will be evaluated using variable registry only) |
Kerberos Principal | sasl.kerberos.principal | | | Principal used for authentication with Kerberos Supports Expression Language: true (will be evaluated using variable registry only) |
Kerberos Keytab | sasl.kerberos.keytab | | | Keytab credentials used for authentication with Kerberos
This property requires exactly one file to be provided..
Supports Expression Language: true (will be evaluated using variable registry only) |
Username | sasl.username | | | Username provided with configured password when using PLAIN or SCRAM SASL Mechanisms Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if the [SASL Mechanism] Property is set to one of the following values: [PLAIN], [SCRAM-SHA-512], [SCRAM-SHA-256] |
Password | sasl.password | | | Password provided with configured username when using PLAIN or SCRAM SASL Mechanisms Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if the [SASL Mechanism] Property is set to one of the following values: [PLAIN], [SCRAM-SHA-512], [SCRAM-SHA-256] |
AWS Profile Name | aws.profile.name | | | The Amazon Web Services Profile to select when multiple profiles are available. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if the [SASL Mechanism] Property |
Token Authentication | sasl.token.auth | false | | Enables or disables Token authentication when using SCRAM SASL Mechanisms
This Property is only considered if the [SASL Mechanism] Property is set to one of the following values: [SCRAM-SHA-512], [SCRAM-SHA-256] |
SSL Context Service | ssl.context.service | | Controller Service API: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService | Service supporting SSL communication with Kafka brokers |
Kafka Key | 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. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Key Attribute Encoding | 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. |
Max Request Size | 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 | ack.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 | max.block.ms | 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 | partitioner.class | DefaultPartitioner | - RoundRobinPartitioner
- DefaultPartitioner
- Expression Language Partitioner
| Specifies which class to use to compute a partition id for a message. Corresponds to Kafka's 'partitioner.class' property. |
Partition | partition | | | Specifies which Partition Records will go to. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Compression Type | compression.type | none | | This parameter allows you to specify the compression codec for all data generated by this producer. |
Dynamic Properties:
Supports Sensitive Dynamic Properties: No
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:
Name | Description |
---|
kafka.tombstone | If this attribute is set to 'true', if the processor is not configured with a demarcator and if the FlowFile's content is null, then a tombstone message with zero bytes will be sent to Kafka. |
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. 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. |
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.