Please be aware this processor is deprecated and may be removed in the near future.
Consumes messages from Apache Kafka specifically built against the Kafka 2.0 Consumer API. The complementary NiFi processor for sending messages is PublishKafka_2_0.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Kafka Brokers | bootstrap.servers | localhost:9092 | | Comma-separated list of Kafka Brokers in the format host:port
Supports Expression Language: true (will be evaluated using variable registry only) |
| 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 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 Credentials Service | kerberos-credentials-service | | Controller Service API:
KerberosCredentialsService
Implementation: KeytabCredentialsService | Service supporting generalized credentials authentication with Kerberos |
| 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] |
| 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] |
| 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 variable registry only)
This Property is only considered if the [SASL Mechanism] Property |
| SSL Context Service | ssl.context.service | | Controller Service API:
SSLContextService
Implementations: StandardSSLContextService
StandardRestrictedSSLContextService | Service supporting SSL communication with Kafka brokers |
| Topic Name(s) | topic | | | The name of the Kafka Topic(s) to pull from. More than one can be supplied if comma separated.
Supports Expression Language: true (will be evaluated using variable registry only) |
| Topic Name Format | topic_type | names | - names
- pattern
| Specifies whether the Topic(s) provided are a comma separated list of names or a single regular expression |
| Honor Transactions | honor-transactions | true | | Specifies whether or not NiFi should honor transactional guarantees when communicating with Kafka. If false, the Processor will use an "isolation level" of read_uncomitted. This means that messages will be received as soon as they are written to Kafka but will be pulled, even if the producer cancels the transactions. If this value is true, NiFi will not receive any messages for which the producer's transaction was canceled, but this can result in some latency since the consumer must wait for the producer to finish its entire transaction instead of pulling as the messages become available. |
| Group ID | group.id | | | A Group ID is used to identify consumers that are within the same consumer group. Corresponds to Kafka's 'group.id' property.
Supports Expression Language: true (will be evaluated using variable registry only) |
| Offset Reset | auto.offset.reset | latest | | Allows you to manage the condition when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted). Corresponds to Kafka's 'auto.offset.reset' property. |
| Key Attribute Encoding | key-attribute-encoding | UTF-8 Encoded | - UTF-8 Encoded
- Hex Encoded
- Do Not Add Key as Attribute
| FlowFiles that are emitted have an attribute named 'kafka.key'. This property dictates how the value of the attribute should be encoded. |
| Message Demarcator | message-demarcator | | | Since KafkaConsumer receives messages in batches, you have an option to output FlowFiles which contains all Kafka messages in a single batch for a given topic and partition and this property allows you to provide a string (interpreted as UTF-8) to use for demarcating apart multiple Kafka messages. This is an optional property and if not provided each Kafka message received will result in a single FlowFile which time it is triggered. To enter special character such as 'new line' use CTRL+Enter or Shift+Enter depending on the OS
Supports Expression Language: true (will be evaluated using variable registry only) |
| Separate By Key | separate-by-key | false | | If true, and the <Message Demarcator> property is set, two messages will only be added to the same FlowFile if both of the Kafka Messages have identical keys. |
| Message Header Encoding | message-header-encoding | UTF-8 | | Any message header that is found on a Kafka message will be added to the outbound FlowFile as an attribute. This property indicates the Character Encoding to use for deserializing the headers. |
| Headers to Add as Attributes (Regex) | header-name-regex | | | A Regular Expression that is matched against all message headers. Any message header whose name matches the regex will be added to the FlowFile as an Attribute. If not specified, no Header values will be added as FlowFile attributes. If two messages have a different value for the same header and that header is selected by the provided regex, then those two messages must be added to different FlowFiles. As a result, users should be cautious about using a regex like ".*" if messages are expected to have header values that are unique per message, such as an identifier or timestamp, because it will prevent NiFi from bundling the messages together efficiently. |
| Max Poll Records | max.poll.records | 10000 | | Specifies the maximum number of records Kafka should return in a single poll. |
| Max Uncommitted Time | max-uncommit-offset-wait | 1 secs | | Specifies the maximum amount of time allowed to pass before offsets must be committed. This value impacts how often offsets will be committed. Committing offsets less often increases throughput but also increases the window of potential data duplication in the event of a rebalance or JVM restart between commits. This value is also related to maximum poll records and the use of a message demarcator. When using a message demarcator we can have far more uncommitted messages than when we're not as there is much less for us to keep track of in memory. |
| Communications Timeout | Communications Timeout | 60 secs | | Specifies the timeout that the consumer should use when communicating with the Kafka Broker |
Dynamic Properties allow the user to specify both the name and value of a property.