Kafka Reader (Deprecated)

On this Page

Starting from 4.22 GA release, this Snap Pack is deprecated. We recommend you to switch to using Confluent Kafka Snap Pack instead.

Snap type:

Read


Description:

This Snap fetches and consumes data from Kafka under specific topic or topics, and feed the data to the downstream pipeline.

  • Expected input: The input should be a document. User can use parameters to specify the keys of topics, group id, message count or max waiting time in the input document.
  • Expected output:  The output would be a binary output.  The data of the binary is the message from Kafka. The header of it contains the topic(under key “kafka_topic”), partition number(under key “kafka_partition”), offset(“kafka_offset”) and group id(“kafka_group_id”) of this message. If the “Pass Through” option is checked, the upstream document will be stored under key “original” of the header. 


Prerequisites:

[None]


Support and limitations:Works in Ultra Task Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Kafka Accounts (Deprecated) for information on setting up this type of account.


Views:
InputThis Snap has at most one document input view.
OutputThis Snap has exactly one binary output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Topic



Required. Topics this reader should subscribe to. Each reader can subscribe to one or more topics. Topics should be separated by comma.

This attribute can be from a text field, pipeline parameters, or upstream document.

Example: topic1,topic2

Default value: [None]


Group ID


Required. The ID of the consumer group that this reader belongs to. All readers in a consumer group will share the message offset in the Kafka broker. They’ll consume messages cooperatively.

This attribute can be from text field, pipeline parameters or upstream document.

Default value: consumer_group_1


Message count

The number of message to read before consuming stop. If it is equal to 0, it'll wait for some time specified in Max Waiting Time and stop. If it is less than 0, it will wait indefinitely.

This attribute can be from text field, pipeline parameters or upstream document.

Default value: 0


Fetching timeout

Max milliseconds the reader should wait before it gets a message from Kafka. This is the timeout for each fetching request.

This attribute can be from text field, pipeline parameters or upstream document.

Default value: 100

If you have set the Message count property to zero, you must ensure that the Fetching timeout value is large enough to enable the Kafka Reader Snap to receive and read all the incoming messages.
Pass through header

Select this option if pass through the input document as the header of the binary output. This option only works when there is an input view.

Default value: Not selected


Commit synchronously

Commit offset of the message synchronously. If it is checked, the consumer will commit the offset after each message sending.

Default value: Not selected

Snap Execution

Select one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Examples


See Also

Snap Pack History

 Click to view/expand

4.22 (main6403)

4.21 (snapsmrc542)

  • No updates made.

4.20 (snapsmrc535)

  • No updates made.

4.19 (snapsmrc528)

  • No updates made.

4.18 (snapsmrc523)

  • No updates made.

4.17 Patch ALL7402

  • Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17 (snapsmrc515)

  • Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16 (snapsmrc508)

  • No updates made. Automatic rebuild with a platform release.

4.15 (snapsmrc500)

  • No updates made. Automatic rebuild with a platform release.

4.14 (snapsmrc490)

  • No updates made. Automatic rebuild with a platform release.

4.13 (snapsmrc486)

  • No updates made. Automatic rebuild with a platform release.

4.12 (snapsmrc480)

  • No updates made. Automatic rebuild with a platform release.

4.11 [snapsmrc465]

  • No updates made. Automatic rebuild with a platform release.

4.10 (snapsmrc414)

  • No updates made. Automatic rebuild with a platform release.

4.9 (snapsmrc405)

  • No updates made. Automatic rebuild with a platform release.

4.8 (snapsmrc398)

  • Info tab added to accounts.
  • Database accounts now invalidate connection pools if account properties are modified and login attempts fail.

4.7 (snapsmrc382)

  • No updates made. Automatic rebuild with a platform release.

4.6 (snapsmrc362)

  • No updates made. Automatic rebuild with a platform release.

4.5.1 (snapsmrc344)

  • No updates made. Automatic rebuild with a platform release.

4.5.0 (snapsmrc344)

  • This Snap Pack was introduced in this release with a Kafka Reader and Kafka Writer Snap.