ConsumeKafkaRecord_2_6

Description:

Consumes messages from Apache Kafka specifically built against the Kafka 2.6 Consumer API. The complementary NiFi processor for sending messages is PublishKafkaRecord_2_6. Please note that, at this time, the Processor assumes that all records that are retrieved from a given partition have the same schema. If any of the Kafka messages are pulled but cannot be parsed or written with the configured Record Reader or Record Writer, the contents of the message will be written to a separate FlowFile, and that FlowFile will be transferred to the 'parse.failure' relationship. Otherwise, each FlowFile is sent to the 'success' relationship and may contain many individual messages within the single FlowFile. A 'record.count' attribute is added to indicate how many messages are contained in the FlowFile. No two Kafka messages will be placed into the same FlowFile if they have different schemas, or if they have different values for a message header that is included by the <Headers to Add as Attributes> property.

Additional Details...

Tags:

Kafka, Get, Record, csv, avro, json, Ingest, Ingress, Topic, PubSub, Consume, 2.6

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, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
Kafka Brokerslocalhost:9092A comma-separated list of known Kafka Brokers in the format <host>:<port>
Supports Expression Language: true (will be evaluated using variable registry only)
Topic Name(s)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 Formatnames
  • names Topic is a full topic name or comma separated list of names
  • pattern Topic is a regex using the Java Pattern syntax
Specifies whether the Topic(s) provided are a comma separated list of names or a single regular expression
Record ReaderController 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 WriterController 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
Group IDA 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)
Commit Offsetstrue
  • true
  • false
Specifies whether or not this Processor should commit the offsets to Kafka after receiving messages. This value should be false when a PublishKafkaRecord processor is expected to commit the offsets using Exactly Once semantics, and should be reserved for dataflows that are designed to run within Stateless NiFi. See Processor's Usage / Additional Details for more information. Note that setting this value to false can lead to significant data duplication or potentially even data loss if the dataflow is not properly configured.
Max Uncommitted Time1 secsSpecifies 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.

This Property is only considered if the <Commit Offsets> Property has a value of "true".
Honor Transactionstrue
  • true
  • false
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.
Security ProtocolPLAINTEXT
  • PLAINTEXT PLAINTEXT
  • SSL SSL
  • SASL_PLAINTEXT SASL_PLAINTEXT
  • SASL_SSL SASL_SSL
Protocol used to communicate with brokers. Corresponds to Kafka's 'security.protocol' property.
SASL MechanismGSSAPI
  • GSSAPI The mechanism for authentication via Kerberos. The principal and keytab must be provided to the processor by using a Keytab Credential service, or by specifying the properties directly in the processor.
  • PLAIN The mechanism for authentication via username and password. The username and password properties must be populated when using this mechanism.
  • SCRAM-SHA-256 The Salted Challenge Response Authentication Mechanism using SHA-256. The username and password properties must be set when using this mechanism.
  • SCRAM-SHA-512 The Salted Challenge Response Authentication Mechanism using SHA-512. The username and password properties must be set when using this mechanism.
The SASL mechanism to use for authentication. Corresponds to Kafka's 'sasl.mechanism' property.
Kerberos Credentials ServiceController Service API:
KerberosCredentialsService
Implementation: KeytabCredentialsService		Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos
Kerberos Service NameThe 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 PrincipalThe 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 KeytabThe 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)
UsernameThe 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)
PasswordThe 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 Authfalse
  • true
  • false
When SASL Mechanism is SCRAM-SHA-256 or SCRAM-SHA-512, this property indicates if token authentication should be used.
SSL Context ServiceController Service API:
SSLContextService
Implementations: StandardSSLContextService
StandardRestrictedSSLContextService		Specifies the SSL Context Service to use for communicating with Kafka.
Separate By Keyfalse
  • true
  • false
If true, two Records will only be added to the same FlowFile if both of the Kafka Messages have identical keys.
Key Attribute Encodingutf-8
  • UTF-8 Encoded The key is interpreted as a UTF-8 Encoded string.
  • Hex Encoded The key is interpreted as arbitrary binary data and is encoded using hexadecimal characters with uppercase letters
  • Do Not Add Key as Attribute The key will not be added as an Attribute
If the <Separate By Key> property is set to true, FlowFiles that are emitted have an attribute named 'kafka.key'. This property dictates how the value of the attribute should be encoded.
Offset Resetlatest
  • earliest Automatically reset the offset to the earliest offset
  • latest Automatically reset the offset to the latest offset
  • none Throw exception to the consumer if no previous offset is found for the consumer's group
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.
Message Header EncodingUTF-8Any 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)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 Records10000Specifies the maximum number of records Kafka should return in a single poll.
Communications Timeout60 secsSpecifies the timeout that the consumer should use when communicating with the Kafka Broker

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
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:

NameDescription
successFlowFiles received from Kafka. Depending on demarcation strategy it is a flow file per message or a bundle of messages grouped by topic and partition.
parse.failureIf a message from Kafka cannot be parsed using the configured Record Reader, the contents of the message will be routed to this Relationship as its own individual FlowFile.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
record.countThe number of records received
mime.typeThe MIME Type that is provided by the configured Record Writer
kafka.partitionThe partition of the topic the records are from
kafka.timestampThe timestamp of the message in the partition of the topic.
kafka.topicThe topic records are from

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also:

ConsumeKafka_2_6, PublishKafka_2_6, PublishKafkaRecord_2_6