Skip to content

Latest commit

 

History

History
432 lines (302 loc) · 18.9 KB

CHANGELOG.md

File metadata and controls

432 lines (302 loc) · 18.9 KB
Raw

Confluent's Golang client for Apache Kafka

v2.6.1

This is a maintenance release:

confluent-kafka-go is based on librdkafka v2.6.1, see the librdkafka v2.6.1 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

Fixes

  • Minor optimization to reduce schema ID lookups (#1318).
  • Support transforming maps in Data Contract rules (#1324).
  • Minor optimization to not derive schema when using existing schema (#1327).

v2.6.0

This is a feature release:

  • KIP-848 EA: Admin API for listing consumer groups now has an optional filter to return only groups of given types (#1267).
  • KIP-460 Admin Leader Election RPC (#1311)

confluent-kafka-go is based on librdkafka v2.6.0, see the librdkafka v2.6.0 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v2.5.4

v2.5.4 is a maintenance release with the following fixes and enhancements:

Fixes

  • Upgrade azidentity library to 1.6.0
  • Upgrade vault library to 1.15.0
  • Handle primitives in avrov2 library
  • Allow RuleRegistry to be set in serdes

confluent-kafka-go is based on librdkafka v2.5.3, see the librdkafka v2.5.3 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v2.5.3

v2.5.3 is a maintenance release with the following fixes and enhancements:

Fixes

  • Properly handle 409 conflicts when registering KEKs/DEKs
  • Run rule actions when a rule condition fails
  • Include deleted schemas when getting schemas by subject and version
  • Handle signed ints when transforming Protobuf payloads
  • Use correct URL when calling DEK Registry to retrieve a DEK by version
  • Upgrade Hamba Avro library to 2.24.0
  • Perform Avro schema resolution in the Avro deserializer if necessary
  • Add some missing APIs to the Schema Registry client

confluent-kafka-go is based on librdkafka v2.5.3, see the librdkafka v2.5.3 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

There were no v2.5.1 or v2.5.2 releases.

v2.5.0

Warning

This version has introduced a regression in which an assert is triggered during PushTelemetry call. This happens when no metric is matched on the client side among those requested by broker subscription.

You won't face any problem if:

  • Broker doesn't support KIP-714.
  • KIP-714 feature is disabled on the broker side.
  • KIP-714 feature is disabled on the client side. This is enabled by default. Set configuration enable.metrics.push to false.
  • If KIP-714 is enabled on the broker side and there is no subscription configured there.
  • If KIP-714 is enabled on the broker side with subscriptions that match the KIP-714 metrics defined on the client.

Having said this, we strongly recommend using v2.5.3 and above to not face this regression at all.

This is a feature release.

  • Adds an AdminAPI DeleteRecords() (#1141, @PratRanj07).
  • Add support for metadata and ruleSet in the schema registry client, which together support data contracts.
  • Add a new Avro package "avrov2" which uses the Avro hamba library. The old package "avro" uses Avro libraries which are no longer maintained and should not be used in new code.
  • Move rest service for schema registry client into internal package for use by both the SR client and the DEK Registry client.
  • Add support for CSFLE (client-side field-level encryption) for AWS, Azure, GCP, and HashiCorp Vault. See the encryption examples in the examples directory.
  • Add support for CEL, CEL_FIELD, and JSONata rules.

Fixes

  • Issues: #965 Windows builds are linked to libssp in addition to other libraries, since the bundled zstd and zlib are built with -fstack-protector, and not linking causes build failures. Happening since 2.0.0 (#1184).

confluent-kafka-go is based on librdkafka v2.5.0, see the librdkafka v2.5.0 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v2.4.0

This is a feature release.

  • KIP-848: Integration tests running with the new consumer group protocol. The feature is an Early Access: not production ready (#1185).
  • Allow custom http.Client to be passed to schema registry client (#1099)
  • Cache schemas when setting UseLatestVersion=true (#1100)
  • Add CacheLatestTtlSecs to allow expiration of latest schemas (#1106)
  • Cache parsed file descriptors in Protobuf deserializer (#1128)
  • Add CacheSchemas option to Protobuf serializer (#1151)
  • Add tags field to Confluent metadata (#1131)

Fixes

  • The version of Go in go.mod has been changed from 1.17 to 1.21. This is necessary to update test dependencies with security vulnerabilities. Code using the library will still work with Go 1.17. (#1136, @rzeijde).
  • Fix JSON validation during serialization (#1101)
  • Fix counter in mock schema registry client (#1170)

confluent-kafka-go is based on librdkafka v2.4.0, see the librdkafka v2.4.0 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v2.3.0

This is a feature release.

  • Adds support for AdminAPI DescribeCluster() and DescribeTopics() (#964, @jainruchir).
  • KIP-430: Return authorized operations in Describe Responses. (#964, @jainruchir).
  • Adds Rack to the Node type, so AdminAPI calls can expose racks for brokers (currently, all Describe Responses) (#964, @jainruchir).
  • KIP-396: completed the implementation with the addition of ListOffsets (#1029).
  • Adds cache for Schema Registry client's GetSchemaMetadata (#1042).
  • MockCluster can now be shutdown and started again to test broker availability problems (#998, @kkoehler).
  • Adds CreateTopic method to the MockCluster. (#1047, @mimikwang).
  • Honor HTTPS_PROXY environment variable, if set, for the Schema Registry client (#1065, @finncolman).
  • KIP-516: Partial support of topic identifiers. Topic identifiers in metadata response are available through the new DescribeTopics function (#1068).

Fixes

  • Fixes a bug in the mock schema registry client where the wrong ID was being returned for pre-registered schema (#971, @srlk).
  • The minimum version of Go supported has been changed from 1.16 to 1.17 (#1074).
  • Fixes an issue where testing was being imported by a non-test file, testhelpers.go. (#1049, @dmlambea).
  • Fixes the optional Coordinator field in ConsumerGroupDescription in case it's not known. It now contains a Node with ID -1 in that case. Avoids a C segmentation fault.
  • Fixes an issue with Producer.Flush. It was waiting for queue.buffering.max.ms while flushing (#1013).
  • Fixes an issue where consumer methods would not be allowed to run while the consumer was closing, and during the final partition revoke (#1073).

confluent-kafka-go is based on librdkafka v2.3.0, see the librdkafka v2.3.0 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v2.2.0

This is a feature release.

  • KIP-339 IncrementalAlterConfigs API (#945).
  • KIP-554: User SASL/SCRAM credentials alteration and description (#1004).

Fixes

  • Fixes a nil pointer bug in the protobuf Serializer.Serialize(), caused due to an unchecked error (#997, @baganokodo2022).
  • Fixes incorrect protofbuf FileDescriptor references (#989, @Mrmann87).
  • Allow fetching all partition offsets for a consumer group by passing a nil slice in AdminClient.ListConsumerGroupOffsets, when earlier it was not processing that correctly (#985, @alexandredantas).
  • Deprecate m.LeaderEpoch in favor of m.TopicPartition.LeaderEpoch (#1012).

confluent-kafka-go is based on librdkafka v2.2.0, see the librdkafka v2.2.0 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v2.1.1

This is a maintenance release.

It is strongly recommended to update to v2.1.1 if v2.1.0 is being used, as it fixes a critical issue in the consumer (#980).

confluent-kafka-go is based on librdkafka v2.1.1, see the librdkafka v2.1.1 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v2.1.0

This is a feature release:

  • Added Consumer SeekPartitions() method to seek multiple partitions at once and deprecated Seek() (#940).
  • KIP-320: add offset leader epoch to the TopicPartition
    and Message structs (#968).
  • The minimum version of Go supported has been changed from 1.14 to 1.16 (#973).
  • Add validation on the Producer, the Consumer and the AdminClient to prevent panic when they are used after close (#901).
  • Fix bug causing schema-registry URL with existing path to not be parsed correctly (#950).
  • Support for Offset types on Offset.Set() (#962, @jdockerty).
  • Added example for using rebalance callback with manual commit.

confluent-kafka-go is based on librdkafka v2.1.0, see the librdkafka v2.1.0 release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v2.0.2

This is a feature release:

  • Added SetSaslCredentials. This new method (on the Producer, Consumer, and AdminClient) allows modifying the stored SASL PLAIN/SCRAM credentials that will be used for subsequent (new) connections to a broker.
  • Channel based producer (Producer ProduceChannel()) and channel based consumer (Consumer Events()) are deprecated.
  • Added IsTimeout() on Error type. This is a convenience method that checks if the error is due to a timeout.
  • The timeout parameter on Seek() is now ignored and an infinite timeout is used, the method will block until the fetcher state is updated (typically within microseconds).
  • The minimum version of Go supported has been changed from 1.11 to 1.14.
  • KIP-222 Add Consumer Group operations to Admin API.
  • KIP-518 Allow listing consumer groups per state.
  • KIP-396 Partially implemented: support for AlterConsumerGroupOffsets.
  • As result of the above KIPs, added (#923)
    • ListConsumerGroups Admin operation. Supports listing by state.
    • DescribeConsumerGroups Admin operation. Supports multiple groups.
    • DeleteConsumerGroups Admin operation. Supports multiple groups (@vsantwana).
    • ListConsumerGroupOffsets Admin operation. Currently, only supports 1 group with multiple partitions. Supports the requireStable option.
    • AlterConsumerGroupOffsets Admin operation. Currently, only supports 1 group with multiple offsets.
  • Added SetRoundtripDuration to the mock broker for setting RTT delay for a given mock broker (@kkoehler, #892).
  • Built-in support for Linux/ arm64. (#933).

Fixes

  • The SpecificDeserializer.Deserialize method was not returning its result result correctly, and was hence unusable. The return has been fixed (#849).
  • The schema ID to use during serialization, specified in SerializerConfig, was ignored. It is now used as expected (@perdue, #870).
  • Creating a new schema registry client with an SSL CA Certificate led to a panic. This was due to a nil pointer, fixed with proper initialization (@HansK-p, @ju-popov, #878).

Upgrade considerations

  • OpenSSL 3.0.x upgrade in librdkafka requires a major version bump, as some legacy ciphers need to be explicitly configured to continue working, but it is highly recommended not to use them. The rest of the API remains backward compatible, see the librdkafka release notes below for details.
  • As required by the Go module system, a suffix with the new major version has been added to the module name, and package imports must reflect this change.

confluent-kafka-go is based on librdkafka v2.0.2, see the librdkafka v2.0.0 release notes and later ones for a complete list of changes, enhancements, fixes and upgrade considerations.

Note: There were no confluent-kafka-go v2.0.0 or v2.0.1 releases.

v1.9.2

This is a maintenance release:

  • Bundles librdkafka v1.9.2.
  • Example for using go clients with AWS lambda (@jliunyu, #823).
  • OAUTHBEARER unsecured producer, consumer and OIDC examples.

confluent-kafka-go is based on librdkafka v1.9.2, see the librdkafka release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v1.9.1

This is a feature release:

confluent-kafka-go is based on librdkafka v1.9.1, see the librdkafka release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v1.9.0

This is a feature release:

  • OAUTHBEARER OIDC support
  • KIP-140 Admin API ACL support
  • Added MockCluster for functional testing of applications without the need for a real Kafka cluster (by @SourceFellows and @kkoehler, #729). See examples/mock_cluster.

Fixes

  • Fix Rebalance events behavior for static membership (@jliunyu, #757, #798).
  • Fix consumer close taking 10 seconds when there's no rebalance needed (@jliunyu, #757).

confluent-kafka-go is based on librdkafka v1.9.0, see the librdkafka release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v1.8.2

This is a maintenance release:

  • Bundles librdkafka v1.8.2
  • Check termination channel while reading delivery reports (by @zjj)
  • Added convenience method Consumer.StoreMessage() (@finncolman, #676)

confluent-kafka-go is based on librdkafka v1.8.2, see the librdkafka release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

Note: There were no confluent-kafka-go v1.8.0 and v1.8.1 releases.

v1.7.0

Enhancements

  • Experimental Windows support (by @neptoess).
  • The produced message headers are now available in the delivery report Message.Headers if the Producer's go.delivery.report.fields configuration property is set to include headers, e.g.: "go.delivery.report.fields": "key,value,headers" This comes at a performance cost and are thus disabled by default.

Fixes

  • AdminClient.CreateTopics() previously did not accept default value(-1) of ReplicationFactor without specifying an explicit ReplicaAssignment, this is now fixed.

confluent-kafka-go is based on librdkafka v1.7.0, see the librdkafka release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

v1.6.1

v1.6.1 is a feature release:

  • KIP-429: Incremental consumer rebalancing - see cooperative_consumer_example.go for an example how to use the new incremental rebalancing consumer.
  • KIP-480: Sticky producer partitioner - increase throughput and decrease latency by sticking to a single random partition for some time.
  • KIP-447: Scalable transactional producer - a single transaction producer can now be used for multiple input partitions.

confluent-kafka-go is based on and bundles librdkafka v1.6.1, see the librdkafka release notes for a complete list of changes, enhancements, fixes and upgrade considerations.

Enhancements

  • go.delivery.report.fields=all,key,value,none can now be used to avoid copying message key and/or value to the delivery report, improving performance in high-throughput applications (by @kevinconaway).

Fixes

  • Consumer.Close() previously did not trigger the final RevokePartitions callback, this is now fixed.

v1.5.2

v1.5.2 is a maintenance release with the following fixes and enhancements:

  • Bundles librdkafka v1.5.2 - see release notes for all enhancements and fixes.
  • Documentation fixes

confluent-kafka-go is based on librdkafka v1.5.2, see the librdkafka release notes for a complete list of changes, enhancements, fixes and upgrade considerations.