ConsumeKafka_0

Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id C03E4200D14 for ; Tue, 3 Oct 2017 15:30:46 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id BEC98160BF2; Tue, 3 Oct 2017 13:30:46 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 904F71609D2 for ; Tue, 3 Oct 2017 15:30:44 +0200 (CEST) Received: (qmail 30181 invoked by uid 500); 3 Oct 2017 13:30:38 -0000 Mailing-List: contact commits-help@nifi.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@nifi.apache.org Delivered-To: mailing list commits@nifi.apache.org Received: (qmail 29875 invoked by uid 99); 3 Oct 2017 13:30:38 -0000 Received: from Unknown (HELO svn01-us-west.apache.org) (209.188.14.144) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 03 Oct 2017 13:30:38 +0000 Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id 8773D3A0B37 for ; Tue, 3 Oct 2017 13:30:34 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1811008 [12/43] - in /nifi/site/trunk/docs: ./ nifi-docs/ nifi-docs/components/ nifi-docs/components/org.apache.nifi/ nifi-docs/components/org.apache.nifi/nifi-ambari-nar/ nifi-docs/components/org.apache.nifi/nifi-ambari-nar/1.4.0/ nifi-do... Date: Tue, 03 Oct 2017 13:30:27 -0000 To: commits@nifi.apache.org From: jstorck@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20171003133034.8773D3A0B37@svn01-us-west.apache.org> archived-at: Tue, 03 Oct 2017 13:30:46 -0000 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-11-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_11/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-11-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_11/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-11-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_11/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-11-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_11/index.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1 @@ +ConsumeKafka_0_11

Description:

Consumes messages from Apache Kafka specifically built against the Kafka 0.11.x Consumer API. 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 sending messages is PublishKafka_0_11.

Tags:

Kafka, Get, Ingest, Ingress, Topi c, PubSub, Consume, 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
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.
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
Topic Name Format	names	names pattern	Specifies whether the Topic(s) provided are a comma separated list of names or a single regular expression
Honor Transactions	true	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.
Group ID			A Group ID is used to identify consumers that are within the same consumer group. Corresponds to Kafka's 'group.id' property.
Offset Reset	latest	earliest latest none	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	utf-8	UTF-8 Encoded Hex Encoded	FlowFiles that are emitted have a n attribute named 'kafka.key'. This property dictates how the value of the attribute should be encoded.
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
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)			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	10000		Specifies the maximum number of records Kafka should return in a single poll.
Max Uncommitted Time	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.

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.

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.

Relationships:

Name	Description
success	FlowFiles received from Kafka. Depending on demarcation strategy it is a flow file per message or a bundle of messages grouped by topic and partition.

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
kafka.count	The number of messages written if more than one
kafka.key	The key of message if present and if single message. How the key is encoded depends on the value of the 'Key Attribute Encoding' property.
kafka.offset	The offset of the message in the partition of the topic.
kafka.partition	The partition of the topic the message or message bundle is from
kafka.topic	The topic the message or message bundle is 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. \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-11-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_11/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-11-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_11/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-11-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_11/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-11-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_11/index.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1 @@ +PublishKafkaRecord_0_11

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:

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 in order 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 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 R eplicated 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 re gex 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 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
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 load ing 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.

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 load ing 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.

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.

Rest ricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

Description:

Sends the contents of a FlowFile as a message to Apache Kafka using the Kafka 0.11.x Producer API.The messages to send may be individual FlowFiles or may be delimited, using a user-specified delimiter, such as a new-line. 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. Th e complementary NiFi processor for fetching messages is ConsumeKafka_0_11.

Tags:

Apache, Kafka, Put, Send, Message, PubSub, 0.11.x

Properties:

< td id="allowable-values">

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
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.
Topic Name			The name of the Kafka Topic to publish to. Supports Expression Language: true
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.
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 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 "Gua rantee Replicated Delivery."
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.
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 i t is present and we're not demarcating. Supports Expression Language: true
Key Attribute Encoding	utf-8	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.
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
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, th is 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
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:

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.

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:

NameDescriptionmsg.countThe 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. \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.GetKafka/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.GetKafka/additionalDetails.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.GetKafka/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.GetKafka/additionalDetails.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1,45 @@ + + + + + + GetKafka + + + + + +

Description:

+ This Processors polls Apache Kafka + for data. When a message is received from Kafka, this Processor emits a FlowFile + where the content of the FlowFile is the value of the Kafka message. If the + message has a key associated with it, an attribute named kafka.key + will be added to the FlowFile, with the value being the UTF-8 Encoded value + of the Message's Key. +

+ Kafka supports the notion of a Consumer Group when pulling messages in order to + provide scalability while still offering a publish-subscribe interface. Each + Consumer Group must have a unique identifier. The Consumer Group identifier that + is used by NiFi is the UUID of the Processor. This means that all of the nodes + within a cluster will use the same Consumer Group Identifier so that they do + not receive duplicate data but multiple GetKafka Processors can be used to pull + from multiple Topics, as each Processor will receive a different Processor UUID + and therefore a different Consumer Group Identifier. +

+ + Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.GetKafka/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.GetKafka/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.GetKafka/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.GetKafka/index.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1 @@ +GetKafka

Description:

Fetches messages from Apache Kafka, specifically for 0.8.x versions. The complementary NiFi processor for sending messages is PutKafka.

Additional Details...

Tags:

Kafka, Apache, Get, Ingest, Ingress, Topic, PubSub, 0.8.x

Properties:

Name	Default Value	Allowable Values	Description
ZooKeeper Connection String			The Connection String to use in order to connect to ZooKeeper. This is often a comma-separated list of <host>:<port> combinations. For example, host1:2181,host2:2181,host3:2188 Supports Expression Language: true
Topic Name			The Kafka Topic to pull messages from Supports Expression Language: true
Zookeeper Commit Frequency	60 secs		Specifies how often to communicate with Zo oKeeper to indicate which messages have been pulled. A longer time period will result in better overall performance but can result in more data duplication if a NiFi node is lost
Batch Size	1		Specifies the maximum number of messages to combine into a single FlowFile. These messages will be concatenated together with the <Message Demarcator> string placed between the content of each message. If the messages from Kafka should not be concatenated together, leave this value at 1.
Message Demarcator	\n		Specifies the characters to use in order to demarcate multiple messages from Kafka. If the <Batch Size> property is set to 1, this value is ignored. Otherwise, for each two subsequent messages in the batch, this value will be pl aced in between them.
Client Name	NiFi-mock-processor		Client Name to use when communicating with Kafka
Group ID	mock-processor		A Group ID is used to identify consumers that are within the same consumer group Supports Expression Language: true
Kafka Communications Timeout	30 secs		The amount of time to wait for a response from Kafka before determining that there is a communications error
ZooKeeper Communications Timeout	30 secs		The amount of time to wait for a respo nse from ZooKeeper before determining that there is a communications error
Auto Offset Reset	largest	smallest largest	Automatically reset the offset to the smallest or largest offset available on the broker

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 as part of the static properties, its value wil be overridden with warning message describing the override. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration.

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 as part of the static properties, its value wil be overridden with warning message describing the override. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration.

Relationships:

Name	Description
success	All FlowFiles that are created are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
kafka.topic	The name of the Kafka Topic from which the message was received
kafka.key	The key of the Kafka message, if it exists and batch size is 1. If the message does not have a key, or if the batch size is greater than 1, this attribute will not be added
kafka.partition	The partition of the Kafka Topic from which the message was received. This attribute is added only if the batch size is 1
kafka.offset	The offset of the message within the Kafka partition. This attribute is added only if the batch size is 1

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship. \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.PutKafka/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.PutKafka/additionalDetails.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.PutKafka/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.PutKafka/additionalDetails.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1,45 @@ + + + + + + PutKafka + + + + + +

Description:

+ This Processors puts the contents of a FlowFile to a Topic in + Apache Kafka. The full contents of + a FlowFile becomes the contents of a single message in Kafka. + This message is optionally assigned a key by using the + <Kafka Key> Property. +

+ +

+ The Processor allows the user to configure an optional Message Delimiter that + can be used to send many messages per FlowFile. For example, a \n could be used + to indicate that the contents of the FlowFile should be used to send one message + per line of text. If the property is not set, the entire contents of the FlowFile + will be sent as a single message. When using the delimiter, if some messages are + successfully sent but other messages fail to send, the FlowFile will be FORKed into + two child FlowFiles, with the successfully sent messages being routed to 'success' + and the messages that could not be sent going to 'failure'. +

+ + Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.PutKafka/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.PutKafka/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.PutKafka/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-8-nar/1.4.0/org.apache.nifi.processors.kafka.PutKafka/index.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1 @@ +PutKafka

Description:

Sends the contents of a FlowFile as a message to Apache Kafka, specifically for 0.8.x versions. The messages to send may be individual FlowFiles or may be delimited, using a user-specified delimiter, such as a new-line. The complementary NiFi processor for fetching messages is GetKafka.

Additional Details...

Tags:

Apache, Kafka, Put, Send, Message, PubSub, 0.8.x

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) a re considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Name	Default Value	Allowable Values	Description
Known Brokers			A comma-separated list of known Kafka Brokers in the format <host>:<port> Supports Expression Language: true
Topic Name			The Kafka Topic of interest Supports Expression Language: true
Partition			Specifies which Kafka Partition to add the message to. If using a m essage delimiter, all messages in the same FlowFile will be sent to the same partition. If a partition is specified but is not valid, then the FlowFile will be routed to failure relationship. Supports Expression Language: true
Kafka Key			The Key to use for the Message Supports Expression Language: true
Delivery Guarantee	0	Best Effort Guarantee Single Node Delivery Guarantee Replicated Delivery	Specifies the requirement for guaranteeing that a message is sent to Kafka
Message Delimiter			Specifies the delimiter (interpreted in its UTF-8 byte representation) to use for splitting apart 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. Note that if messages are delimited and some messages for a given FlowFile are transferred successfully while others are not, the messages will be split into individual FlowFiles, such that those messages that were successfully sent are routed to the 'success' relationship while other messages are sent to the 'failure' relationship. Supports Expression Language: true< /strong>
Max Buffer Size	5 MB		The maximum amount of data to buffer in memory before sending to Kafka
Max Record Size	1 MB		The maximum size that any individual record can be.
Communications Timeout	30 secs		The amount of time to wait for a response from Kafka before determining that there is a communications error
Batch Size	16384		This configuration controls the default batch size in bytes.The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This helps performance on both the client and the server.
Queue Buffering Max Time			Maximum time to buffer data before sending to Kafka. For example a setting of 100 ms will try to batch together 100 milliseconds' worth of messages to send at once. This will improve throughput but adds message delivery latency due to the buffering.
Compression Codec	none	None GZIP Snappy	This parameter allows you to specify the compression codec for all data generated by this producer.
Client Name			Client Name to use when communicating with Kafka

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 as part of the static properties, its value wil be ove rriden with warning message describing the override. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration.

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 as part of the static properties, its value wil be ove rriden with warning message describing the override. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration.

Relationships:

Name	Description
success	Any FlowFile that is successfully sent to Kafka will be routed to this Relationship
failure	Any FlowFile that cannot be sent to Kafka will be routed to this Relationship

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship. \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka/additionalDetails.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka/additionalDetails.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1,33 @@ + + + + + + ConsumeKafka + + + + + +

Description:

+ This Processor polls Apache Kafka + for data using KafkaConsumer API available with Kafka 0.9.x. When a message is received + from Kafka, this Processor emits a FlowFile where the content of the FlowFile is the value + of the Kafka message. +

+ + Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka/index.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1 @@ +ConsumeKafka

Description:

Consumes messages from Apache Kafka specifically built against the Kafka 0.9.x Consumer API. 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 mean time it is possible to enter states where the only resolution will be to restart the JVM NiFi runs on. The complementary NiFi processor for sending messages is PublishKafka.

Additional Details...

< h3>Tags:

Kafka, Get, Ingest, Ingress, Topic, PubSub, Consume, 0.9.x

Properties:

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
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.
SSL Context Service		Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService	Specifies the SSL Context Service to use for communicating with Kafka.
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
Group ID			A Group ID is used to identify consum ers that are within the same consumer group. Corresponds to Kafka's 'group.id' property.
Offset Reset	latest	earliest latest none	Allows you to manage the condition when there is no initial offset in Kafka or if the current offset do es 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	utf-8	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.
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
Max Poll Records	10000		Specifies the maximum number of records Kafka should return in a single poll.
Max Uncommitted Time	1 secs	< /td>	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.

Dynamic Properties:

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.

Relationships:

Name	Description
success	FlowFiles received from Kafka. Depending on demarcation strategy it is a flow file per message or a bundle of messages grouped by topic and partition.

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
kafka.count	The number of messages written if more than one
kafka.key	The key of message if present and if single message. How the key is encoded depends on the value of the 'Key Attribute Encoding' property.
kafka.offset	The offset of the message in the partition of the topic.
kafka.partition	The partition of the topic the message or message bundle is from
kafka.topic	The topic the message or message bundle is 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. \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.PublishKafka/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.PublishKafka/additionalDetails.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.PublishKafka/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-9-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.PublishKafka/additionalDetails.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1,47 @@ + + + + + + PublishKafka + + + + + +

Description:

+ This Processor puts the contents of a FlowFile to a Topic in + Apache Kafka using KafkaProducer API available + with Kafka 0.9.x API. The content of a FlowFile becomes the contents of a Kafka message. + This message is optionally assigned a key by using the <Kafka Key> Property. +

+ +

+ The Processor allows the user to configure an optional Message Demarcator that + can be used to send many messages per FlowFile. For example, a \n could be used + to indicate that the contents of the FlowFile should be used to send one message + per line of text. It also supports multi-char demarcators (e.g., 'my custom demarcator'). + If the property is not set, the entire contents of the FlowFile + will be sent as a single message. When using the demarcator, if some messages are + successfully sent but other messages fail to send, the resulting FlowFile will be + considered a failed FlowFile and will have additional attributes to that effect. + One of such attributes is 'failed.last.idx' which indicates the index of the last message + that was successfully ACKed by Kafka. (if no demarcator is used the value of this index will be -1). + This will allow PublishKafka to only re-send un-ACKed messages on the next re-try. +

+ +

ConsumeKafka_0_11

Description:

Tags:

Properties:

Dynamic Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

PublishKafkaRecord_0_11

Description:

Tags:

Properties:

Dynamic Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Rest ricted:

Input requirement:

See Also:

PublishKafka_0_11

Description:

Tags:

Properties:

Dynamic Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

Description:

GetKafka

Description:

Tags:

Properties:

Dynamic Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

Description:

PutKafka

Description:

Tags:

Properties:

Dynamic Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

Description:

ConsumeKafka

Description:

Properties:

Dynamic Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

Description: