You can configure your Confluent Kafka accounts in SnapLogic using either the Designeror Manager.
Using SnapLogic Designer
Drag a Kafka Snap to the Canvas and click the Snap to open its settings. Click the Account tab. You can now either use an existing account or create a new one.
Selecting an existing account
SnapLogic organizes and displays all accounts to which you have access, sorting them by account type and location. To select an existing account:
Click the icon to view the accounts to which you have access and select the account that you want to use.
Click to save the Snap settings.
Creating an account
Click Add Accountin theAccount Referencedialog.
Select theLocationin which you want to create the account, select the account type, and clickContinue. TheAdd Accountdialog associated with the account type appears.
Enter the required account details. For detailed guidance on how to provide information associated with each account type, use the following links:
Enter additional information on this account in the Notes field of the Info tab. This will help you–and other users–understand the purpose of the account, especially if there are multiple accounts of the same type.
Click Validate to verify the account, if the account type supports validation.
Click Apply to complete configuring the Kafka account.
Using SnapLogic Manager
UseManagerto create accounts without associating them immediately with Pipelines.
Accounts in SnapLogic are associated with projects. You can use accounts created in other projects only if you have at least Read access to them.
In the left pane, browse to the project in which you want to create the account and clickCreate> Account > Confluent Kafka, followed by the appropriate account type.
Avoid updating account credentials while Pipelines using that account are executing. This may lead to unexpected results, including locking your account.
Account Encryption
Standard Encryption
If you use Standard Encryption, the High sensitivity settings under Enhanced Encryption are used.
Enhanced Encryption
If the account you are using has the Enhanced Encryption feature, the account fields are encrypted for each sensitivity level as shown below:
High: [None]
Medium + High: [None]
Low + Medium + High: [None]
Troubleshooting
Error
Reason
Resolution
The message size exceeds the default message limit.
By default, the message size limit is 1 MB. To increase this limit, you must change a few settings in the Confluent Kafka broker and Snap account. On the Confluent Kafka broker side, set the server.properties and producer.properties to a size larger than your message size.
In the Advanced Kafka Properties field of the applicable Snap account settings, you must add max.request.size and set it to a size larger than your message size.
For example, you can increase the message size limit to 15 MB in any one of the following ways:
Assign the following values to properties in Confluent Kafka broker > server.properties:
message.max.bytes = 15728640
replica.fetch.max.bytes = 15728640
max.request.size = 15728640
fetch.message.max.bytes = 15728640
In Confluent Kafka broker > producer.properties, set:
max.request.size = 15728640
In the required Snap account settings, add the following Key/Value pair in the Advanced Kafka Properties field:
max.request.size = 15728640
Snap Pack History
Click to view/expand
Release
Snap Pack Version
Date
Type
Updates
August 2024
438patches28225
Latest
Added the Kafka MSK IAM Account, which enables you to use IAM access control for secure communication with the MSK cluster. You can securely integrate your Kafka pipelines with the MSK cluster.
August 2024
main27765
Stable
Upgraded the org.json.json library from v20090211 to v20240303, which is fully backward compatible.
August 2024
437patches27730
Latest
Fixed an issue with the Kafka Consumer Snap where the Seek Type of Beginning or End (skip all existing messages) may not work correctly after a rebalance.
May 2024
437patches27404
Latest
Fixed an issue with the Kafka SSL Account that displayed an error when the Kafka Consumer Snap could not commit offsets during the rebalancing process. This behavior avoids unstable partition allocation. Now, the Snap logs a warning, allowing the Kafka Consumer to continue processing instead of displaying an exception.
May 2024
437patches26651
Latest
Added Kafka OAuth2 Account to the Kafka Snap Pack to enable the usage of OAuth within the Kafka SASL_SSL framework.
May 2024
main26341
Stable
Kafka Snap Pack: Enhanced the following fields to support expressions through pipeline parameters:
Truststore Password
Keystore File Password
SSL Key Password
SASL Password or Secret
Registry Password or Secret
February 2024
main25112
Stable
Updated and certified against the current SnapLogic Platform release.
November 2023
main23721
Stable
Updated and certified against the current SnapLogic Platform release.
August 2023
main22460
Stable
Updated and certified against the current SnapLogic Platform release.
May 2023
433patches21070
Latest
Fixed an issue with the Kafka Consumer Snap that caused it to skip records in a partition when a pipeline failed without successfully processing any records from that partition. This was an edge case that was only possible with a specific configuration of the Snap and a specific ordering of events during termination of the pipeline.
May 2023
main21015
Stable
Upgraded with the latest SnapLogic Platform release.
Upgraded with the latest SnapLogic Platform release.
November 2022
431patches19770
Latest
Fixed a memory issue that occurred when the Kafka Producer Snap was used to produce many records in a long-running pipeline.
November 2022
431patches19211
Latest
Enhanced the Kafka Consumer Snap with the new Max Poll Interval (ms) field, which allows you to specify the time limit between subsequent calls to poll. This field corresponds to the Kafka max.poll.interval.ms property.
November 2022
main18944
Stable
Upgraded with the latest SnapLogic Platform release.
August 2022
main17386
Stable
Upgraded Kafka client libraries to Apache-Kafka Version 3.1.1 and Confluent-Kafka Version 7.1.1.
Optimized the performance of the Snap with the support for LZ4 and ZSTD compression types of the messages produced.
The Kafka accountthat connects to the Kafka Schema Registry uses TLS v1.2 protocol instead of the older version of TLS, which has security vulnerabilities.
4.29 Patch
429patches17109
Latest
Enhanced the Kafka Producer Snap with LZ4 and ZSTD Compression Types for compressing the messages that optimize Snap's performance.
Fixed an issue with the Kafka Producer Snap where the Snap wrote an output document even when there was an error.
Fixed an issue with Kafka Account where the expression buttons were enabled, by default, for the Bootstrap Server and Advanced Property Value fields.
Upgraded Kafka client libraries to Apache-Kafka Version 3.1.1 and Confluent-Kafka Version 7.1.1.
Enhanced the Kafka account, which is configured to connect to the Kafka Schema Registry, to use TLS v1.2 protocol instead of TLS that has security vulnerabilities.
Fixed an issue with Kafka Snaps where the Snaps failed with null pointer exceptions when logging the cluster information with the controller’s identity not known.
4.28
main14627
Stable
Upgraded with the latest SnapLogic Platform release.
4.27
main12833
Stable
Upgraded with the latest SnapLogic Platform release.
4.26
main11181
Stable
Upgraded with the latest SnapLogic Platform release.
4.25 Patch
425patches10543
Latest
Improved the handling of interrupted/aborted Kafka Snaps to ensure proper clean-up of metrics.
Optimized theKafka Producer Snap to initialize the Kafka API only if there is at least one input document.
Fixed the issue of account passwords being included in the log messages output of Kafka Snaps. The password is now hidden in the logs for both Kafka Consumer and Kafka Producer Snaps.
TheKafka ProducerandConsumerSnaps create a default Client ID string to identify the specific Snap instance.
Enhanced the Kafka Producer Snap to support Avro serialization format with a new target data type Avro under Key and ValueSerializer.
Enhanced the Kafka SSL Account with new fields (Registry Username or Key and Registry Password or Secret) for Schema Registry authentication. The two existing SASL properties (SASL Username and SASL Password) have been revised toSASL Usernameor KeyandSASL Password orSecretrespectively.
Apache Kafka client library is upgraded from version 2.6.0 to 2.8.0.
Confluent Kafka client libraries are updated from version 5.2.1 to 6.2.0.
4.25
main9554
Stable
Upgraded with the latest SnapLogic Platform release.
4.24 Patch
424patches8805
Latest
Fixed an issue in the Kafka Producer Snap by removing the validation of the account when the Snap initialized in a Pipeline execution.
4.24
main8556
Stable
Upgraded with the latest SnapLogic Platform release.
4.23 Patch
423patches7900
Latest
Removed the Confluentprefix from the Snaps and accounts in the Snap Pack. However, the Snap Pack name continues to be Confluent Kafka Snap Pack.
Added theWait For Full Countcheck box to the Kafka Consumer Snapto determine how a positive value for theMessage Countfield must be interpreted.
Enabled (by default): The Snap continues polling for messages until the specified count is reached.
Disabled: If the number of messages that are currently available is less than the specified count, then the Snap consumes the available messages and terminates.
Known Issue
The Wait For Full Count check box activates only when you provide a positive integer value in the Message Count field. However, it does not activate when you use an expression for Message Count even if the value evaluates to a positive number.
Workaround: To activate this check box, temporarily replace the Message Count expression () with a positive integer, select the desired state for Wait For Full Count, and then restore the original value in the Message Count field.
Added support for writing and reading record headers.
TheKafka ProducerSnaphas a newHeaderstable to configure theKey,Value, andSerializerfor each header to be written.
TheKafka ConsumerSnap reads any headers present on the records it consumes. It provides two new fields to configure how the header values should be deserialized – Default Header Deserializer andHeader Deserializers,for any headers that require a deserializer other than the default.
Added support for writing and reading each record’s timestamp.
The Kafka Producer Snap has a new Timestamp field that can be configured to set each record’s timestamp, which is the number of milliseconds since the epoch (00:00:00 UTC on January 1, 1970). This can be set to an expression that evaluates to a long integer, or a string that can be parsed as a long integer, or a date. If you specify no expression, or the value is empty, then the timestamp is set to the current time.
TheTimestampfield is relevant onlyif the Kafka topic is configured withmessage.timestamp.type= CreateTime(which is the default). For more information, see the officialKafka documentation.
TheKafka ConsumerSnap has a new check box, IncludeTimestamp, which by default is disabled for backward compatibility. If enabled, the output for each record includes its timestamp in the metadata.
TheKafka ProducerSnap has a new check box,Output Records, to determine the format of each output document when configured with an output view.
Disabled (by default): The Snap’s output includes only the basic metadata (topic, partition, offset) for each record, along with theoriginalinput document.
Enabled: Each output document contains a more complete representation of the record produced, including its key, value, headers, and timestamp.
TheKafka ConsumerSnap has a new field,Output Mode, with two options:
One output document per record(the default): Every record received from Kafka has a corresponding output document.
One output document per batch: Preserves the batching of records as received from Kafka. Every poll that returns a non-empty set of records results in a single output document containing the list of records asbatch, batch_sizeandbatch_index. This mode is especially useful whenAuto Commitis disabled andAcknowledge ModeisWaitafter each batch of records, depending on the nature of the processing between theKafkaConsumerand theKafka AcknowledgeSnaps.
Removed theAdd 1 to Offsetscheck box from theKafka Consumer Snap.
Removed the Accounttab from theKafka AcknowledgeSnap, because this Snap no longer needs an account.
4.23
main7430
Stable
Fixed an intermittent issue of Confluent Kafka ConsumerSnap stopping when Message Count is 0 while the records are available. The Snap will now stop only if a poll returns no records twice in a row, and haspartitions assigned before and after each poll.
4.22
main6403
Stable
Upgraded with the latest SnapLogic Platform release.
4.21 Patch
421patches6136
Latest
Enhanced the Confluent Kafka Consumer Snap with an option to allow reprocessing of records that remain unacknowledged due to acknowledge timeouts. This ensures that all records from Kafka are processed.
4.21 Patch
421patches5862
Latest
Fixes theConfluent Kafka Consumer Snapthat aborts abruptly upon getting aCommitFailedExceptionerror. Upgraded the Kafka client library from version 2.2 to 2.5.
4.21
snapsmrc542
Stable
Enhanced the Confluent Kafka Consumer Snap to significantly reduce the volume of commit requests for offsets when using the Record acknowledgement mode (Wait after each record), and thereby, improve performance and stability.
4.20 Patch
confluentkafka8747
Latest
Updated theConfluent Kafka SSL Account settings to make the Truststore filepathandTruststore passwordproperties optional.
4.20
snapsmrc535
Stable
Upgraded with the latest SnapLogic Platform release.
4.19
snaprsmrc528
Stable
Upgraded with the latest SnapLogic Platform release.
4.18 Patch
confluentkafka8111
Latest
Fixed an issue with the Confluent Kafka Producer Snap wherein the Topic property doesn't evaluate expression against input documents.
4.18 Patch
confluentkafka8006
Latest
Fixed an exception that occurs while consuminglog-compacted topics, in the Confluent Kafka Consumer Snap.
4.18 Patch
confluentkafka7784
Latest
Fixed the Consumer Snap to stop quickly and cleanly on CLOSE and STOP lifecycle events.
4.18 Patch
confluentkafka7732
Latest
Added support for Kerberos-based authentication to enable connecting to Kerberos-enabled Kafka servers.
4.18
snapsmrc523
Stable
Upgraded with the latest SnapLogic Platform release.
4.17 Patch
confluentkafka7537
Latest
Updated the following Snaps:
Confluent Kafka Consumer Snap
Properties added: Max poll records, Acknowledge mode,Key deserializer,Value deserializer,Add 1 to offsets.
Diagnostic fields added in the metadata object in the Snap's output:
client_id: The unique ID assigned to a single Kafka consumer client instance. All documents written by a Consumer Snap during a single pipeline execution or validation will have the same value for this field.
batch_size: The number of messages in the batch of messages that the current message came from. Note that “batch” isn’t Kafka terminology; we’re using it to mean the set of messages received from the broker in a single call to Kafka’s poll method.
batch_index: The current batch number relative to a single consumer instance. This number starts at 0 for the first batch and is only incremented for batches which contain at least one message.
record_index: The current record number relative to its batch. The first message in a batch has an index of 0; the last has an index of batch_size - 1.
Confluent Kafka Acknowledge Snap: Added new property–Metadata path.
Confluent Kafka Producer Snap: Added new properties–Key serializerandValue serializer.
4.17
ALL7402
Latest
Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17
snapsmrc515
Latest
Tested and certified all Snaps against CDH 6.1.
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 Patch
confluentkafka7118
Latest
Fixed an issue with the Confluent Kafka Producer Snap wherein the Snap fails to produce the upstream Snap's input schema for Partition Number property in the output preview.
4.16 Patch
confluentkafka6891
Latest
Certified Confluent Platform version 5.x.
4.16
snapsmrc508
Stable
Upgraded with the latest SnapLogic Platform release.
4.15 Patch
confluentkafka6446
Latest
Fixed an issue with the Confluent Kafka Consumer Snap wherein some connections were not closed after a Pipeline is aborted.
4.15
snapsmrc500
Stable
Upgraded with the latest SnapLogic Platform release.
4.14 Patch
confluentkafka5737
Latest
Added a new property to the Confluent Kafka Producer Snap, Message publish timeout (milliseconds), that lets you specify a timeout value.
4.14 Patch
confluentkafka5663
Latest
Fixed the Confluent Kafka Snaps that do not delete temp files after pipeline execution.
4.14
snapsmrc490
Stable
Upgraded with the latest SnapLogic Platform release.
4.13 Patch
confluentkafka5614
Latest
Fixed the Confluent Kafka Snap Pack that does not delete the temp files after executing pipelines.
4.13 Patch
confluentkafka5330
Latest
Added support in Confluent Kafka Producer Snap the ability to write data to multiple partitions, in a round robin fashion.
4.13
snapsmrc486
Stable
Upgraded with the latest SnapLogic Platform release.
4.12 Patch
confluentkafka5087
Latest
Fixed an issue with the Consumer Snap that fails when the specified timeout value is less than the pipeline execution time.
4.12
snapsmrc480
Stable
Enhanced the performance of the Confluent Kafka Producer Snap in writing incoming documents into the Confluent Kafka Cluster.
4.11 Patch
confluentkafka4626
Latest
Fixed an issue with the Confluent Kafka Consumer Snap wherein the Consumer session is not closing properly whenmanually stopping a pipeline, which causes the subsequent pipeline execution to wait for the previous session to die and not consume messages.
4.11 Patch
confluentkafka4302
Latest
Fixed an issue with the Confluent Kafka Consumer Snap that fetched 500 messages only, when message count set to 0 caused due to driver default value change.