Skip to content

Commit 056c553

Browse files
committed
adding SDK version support matrix
1 parent 3a6c400 commit 056c553

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

articles/event-hubs/geo-replication.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ Consuming applications can consume data using the namespace hostname of a namesp
155155

156156
### Checkpointing/Offset Management
157157

158-
Event consuming applications can continue to maintain offset management as they would do it with a single namespace.
158+
Event consuming applications can continue to maintain offset management as they would do it with a non-geo replicated namespace. No special consideration is needed for offset management for geo-replication enabled namespaces.
159159

160160
> [!WARNING]
161161
> In the event of forced failover (i.e. non graceful failover), some of the data that hasn't been copied over may be lost. This may cause the offsets of that specific data to be different across the primary and secondary regions for the namespace, however it would still be within the bounds of the maximum replication lag configured for the namespace.
@@ -164,13 +164,44 @@ Event consuming applications can continue to maintain offset management as they
164164
165165
#### Kafka
166166

167-
Offsets are committed to Event Hubs directly and offsets are replicated across regions. Therefore, consumers can start consuming from where it left off in the primary region.
167+
Offsets are committed to Event Hubs directly and offsets are replicated across regions. Therefore, consumers can start consuming from where it left off in the primary region.
168+
169+
Here are the list of Apache Kafka clients that are supported -
170+
171+
TBD add versions.
172+
| Client name | Version |
173+
| ----------- | ------- |
174+
| Apache Kafka | |
175+
| Librdkafka and derived libraries | |
176+
177+
In the case of other libraries, these are supported based on the versioning of the specific definitions -
178+
179+
TBD add protocol versions.
180+
| Operation name | Version supported |
181+
| -------------- | ----------------- |
182+
|||
183+
|||
184+
|||
185+
168186

169187
#### Event Hubs SDK/AMQP
170188

171-
TBD - call out that Track 0 SDKs will have trouble. Track 1 and later are fine.
189+
In the case of AMQP, the checkpoint is managed by users with a checkpoint store such as Azure Blob storage or a custom storage solution. If there's a failover, the checkpoint store must be available from the secondary region so that clients can retrieve checkpoint data and avoid loss of messages.
190+
191+
The latest version of the Event Hubs SDK has made some changes to checkpoint representation to supports failovers. We recommend using the [latest versions of the SDKs](sdks.md), but prior versions of the below SDKs are supported as well.
172192

173-
Clients that use the Event Hubs SDK need to upgrade to the April 2024 version of the SDK. The latest version of the Event Hubs SDK supports failover with an update to the checkpoint. The checkpoint is managed by users with a checkpoint store such as Azure Blob storage, or a custom storage solution. If there's a failover, the checkpoint store must be available from the secondary region so that clients can retrieve checkpoint data and avoid loss of messages.
193+
TBD add other language package names
194+
195+
| Language | Package name|
196+
| -------- | ----------- |
197+
| C# | [Azure.Messaging.EventHubs](https://www.nuget.org/packages/Azure.Messaging.EventHubs/) |
198+
| C# | [Microsoft.Azure.EventHubs](https://www.nuget.org/packages/Microsoft.Azure.EventHubs/) |
199+
200+
> [!WARNING]
201+
> If you use the legacy SDK, [Windows.Azure.ServiceBus](https://www.nuget.org/packages/WindowsAzure.ServiceBus/) you may encounter issues consuming from a geo-replication namespace after promotion of the secondary to primary.
202+
>
203+
> It is recommended to upgrade to the [latest versions of the SDKs](sdks.md)
204+
>
174205
175206
## Considerations
176207

0 commit comments

Comments
 (0)