.NET Change Feed Processor SDK: Download and release notes (Legacy)

APPLIES TO: NoSQL

	Links
SDK download	NuGet
API documentation	Change Feed Processor library API reference documentation
Get started	Get started with the Change Feed Processor .NET SDK
Current supported framework	Microsoft .NET Framework 4.5 Microsoft .NET Core

Release notes

v2 builds

2.5.0

• Added new constructor for the Microsoft.Azure.Documents.ChangeFeedProcessor.Logging.TraceLogProvider class that takes an instance of the System.Diagnostics.TraceSource as an argument. This allows the TraceLogProvider, which is used for .net tracing, to be created programmatically from a custom TraceSource instance initialized in source code. Before this change it was only possible to configure .net tracing using App.config file.

2.4.0

• Added support for lease collections that can be partitioned with partition key defined as /partitionKey. Prior to this change lease collection's partition key would have to be defined as /id.
• This release allows using lease collections with API for Gremlin, as Gremlin collections cannot have partition key defined as /id.

2.3.2

• Added lease store compatibility with [V3 SDK that enables hot migration paths. An application can migrate to V3 SDK and migrate back to the Change Feed processor library without losing any state.

2.3.1

• Corrected a case when FeedProcessing.ChangeFeedObserverCloseReason.Unknown close reason was sent to FeedProcessing.IChangeFeedObserver.CloseAsync if the partition cannot be found or if the target replica is not up to date up with the read session. In these cases FeedProcessing.ChangeFeedObserverCloseReason.ResourceGone and FeedProcessing.ChangeFeedObserverCloseReason.ReadSessionNotAvailable close reasons are now used.
• Added a new close reason FeedProcessing.ChangeFeedObserverCloseReason.ReadSessionNotAvailable that is sent to close the change feed observer when the target replica is not up to date up with the read session.

2.3.0

• Added a new method ChangeFeedProcessorBuilder.WithCheckpointPartitionProcessorFactory and corresponding public interface ICheckpointPartitionProcessorFactory. This allows an implementation of the IPartitionProcessor interface to use built-in checkpointing mechanism. The new factory is similar to the existing IPartitionProcessorFactory, except that its Create method also takes the ILeaseCheckpointer parameter.
• Only one of the two methods, either ChangeFeedProcessorBuilder.WithPartitionProcessorFactory or ChangeFeedProcessorBuilder.WithCheckpointPartitionProcessorFactory, can be used for the same ChangeFeedProcessorBuilder instance.

2.2.8

• Stability and diagnosability improvements:
  • Added support to detect reading change feed taking long time. When it takes longer than the value specified by the ChangeFeedProcessorOptions.ChangeFeedTimeout property, the following steps are taken:
    • The operation to read change feed on the problematic partition is aborted.
    • The change feed processor instance drops ownership of the problematic lease. The dropped lease will be picked up during the next lease acquire step that will be done by the same or different change feed processor instance. This way, reading change feed will start over.
    • An issue is reported to the health monitor. The default heath monitor sends all reported issues to trace log.
  • Added a new public property: ChangeFeedProcessorOptions.ChangeFeedTimeout. The default value of this property is 10 mins.
  • Added a new public enum value: Monitoring.MonitoredOperation.ReadChangeFeed. When the value of HealthMonitoringRecord.Operation is set to Monitoring.MonitoredOperation.ReadChangeFeed, it indicates the health issue is related to reading change feed.

2.2.7

• Improved load-balancing strategy for scenario when getting all leases takes longer than lease expiration interval, for example, due to network issues:
  • In this scenario load-balancing algorithm used to falsely consider leases as expired, causing stealing leases from active owners. This could trigger unnecessary rebalancing many leases.
  • This issue is fixed in this release by avoiding retry on conflict while acquiring expired lease which owner hasn't changed and postponing acquiring expired lease to next load-balancing iteration.

2.2.6

• Improved handling of Observer exceptions.
• Richer information on Observer errors:
  • When an Observer is closed due to an exception thrown by Observer's ProcessChangesAsync, the CloseAsync will now receive the reason parameter set to ChangeFeedObserverCloseReason.ObserverError.
  • Added traces to identify errors within user code in an Observer.

2.2.5

• Added support for handling split in collections that use shared database throughput.
  • This release fixes an issue that may occur during split in collections using shared database throughput when split result into partition rebalancing with only one child partition key range created, rather than two. When this happens, Change Feed Processor may get stuck deleting the lease for old partition key range and not creating new leases. The issue is fixed in this release.

2.2.4

• Added new property ChangeFeedProcessorOptions.StartContinuation to support starting change feed from request continuation token. This is only used when lease collection is empty or a lease does not have ContinuationToken set. For leases in lease collection that have ContinuationToken set, the ContinuationToken is used and ChangeFeedProcessorOptions.StartContinuation is ignored.

2.2.3

• Added support for using custom store to persist continuation tokens per partition.
  • For example, a custom lease store can be Azure Cosmos DB lease collection partitioned in any custom way.
  • Custom lease stores can use new extensibility point ChangeFeedProcessorBuilder.WithLeaseStoreManager(ILeaseStoreManager) and ILeaseStoreManager public interface.
  • Refactored the ILeaseManager interface into multiple role interfaces.
• Minor breaking change: removed extensibility point ChangeFeedProcessorBuilder.WithLeaseManager(ILeaseManager), use ChangeFeedProcessorBuilder.WithLeaseStoreManager(ILeaseStoreManager) instead.

2.2.2

• This release fixes an issue that occurs during processing a split in monitored collection and using a partitioned lease collection. When processing a lease for split partition, the lease corresponding to that partition may not be deleted. The issue is fixed in this release.

2.2.1

• Fixed Estimator calculation for accounts with multiple write regions and new Session Token format.

2.2.0

• Added support for partitioned lease collections. The partition key must be defined as /id.
• Minor breaking change: the methods of the IChangeFeedDocumentClient interface and the ChangeFeedDocumentClient class were changed to include RequestOptions and CancellationToken parameters. IChangeFeedDocumentClient is an advanced extensibility point that allows you to provide custom implementation of the Document Client to use with Change Feed Processor, for example, decorate DocumentClient and intercept all calls to it to do extra tracing, error handling, etc. With this update, the code that implement IChangeFeedDocumentClient will need to be changed to include new parameters in the implementation.
• Minor diagnostics improvements.

2.1.0

• Added new API, Task<IReadOnlyList<RemainingPartitionWork>> IRemainingWorkEstimator.GetEstimatedRemainingWorkPerPartitionAsync(). This can be used to get estimated work for each partition.
• Supports Microsoft.Azure.DocumentDB SDK 2.0. Requires Microsoft.Azure.DocumentDB 2.0 or later.

2.0.6

• Added ChangeFeedEventHost.HostName public property for compatibility with v1.

2.0.5

• Fixed a race condition that occurs during partition split. The race condition may lead to acquiring lease and immediately losing it during partition split and causing contention. The race condition issue is fixed with this release.

2.0.4

• GA SDK

2.0.3-prerelease

• Fixed the following issues:

  • When partition split happens, there could be duplicate processing of documents modified before the split.
  • The GetEstimatedRemainingWork API returned 0 when no leases were present in the lease collection.

• The following exceptions are made public. Extensions that implement IPartitionProcessor can throw these exceptions.

  • Microsoft.Azure.Documents.ChangeFeedProcessor.Exceptions.LeaseLostException.
  • Microsoft.Azure.Documents.ChangeFeedProcessor.Exceptions.PartitionException.
  • Microsoft.Azure.Documents.ChangeFeedProcessor.Exceptions.PartitionNotFoundException.
  • Microsoft.Azure.Documents.ChangeFeedProcessor.Exceptions.PartitionSplitException.

2.0.2-prerelease

• Minor API changes:
  • Removed ChangeFeedProcessorOptions.IsAutoCheckpointEnabled that was marked as obsolete.

2.0.1-prerelease

• Stability improvements:
  • Better handling of lease store initialization. When lease store is empty, only one instance of processor can initialize it, the others will wait.
  • More stable/efficient lease renewal/release. Renewing and releasing a lease one partition is independent from renewing others. In v1 that was done sequentially for all partitions.
• New v2 API:
  • Builder pattern for flexible construction of the processor: the ChangeFeedProcessorBuilder class.
    • Can take any combination of parameters.
    • Can take DocumentClient instance for monitoring and/or lease collection (not available in v1).
  • IChangeFeedObserver.ProcessChangesAsync now takes CancellationToken.
  • IRemainingWorkEstimator - the remaining work estimator can be used separately from the processor.
  • New extensibility points:
    • IPartitionLoadBalancingStrategy - for custom load-balancing of partitions between instances of the processor.
    • ILease, ILeaseManager - for custom lease management.
    • IPartitionProcessor - for custom processing changes on a partition.
• Logging - uses LibLog library.
• 100% backward compatible with v1 API.
• New code base.
• Compatible with SQL .NET SDK versions 1.21.1 and above.

v1 builds

1.3.3

• Added more logging.
• Fixed a DocumentClient leak when calling the pending work estimation multiple times.

1.3.2

• Fixes in the pending work estimation.

1.3.1

• Stability improvements.
  • Fix for handling canceled tasks issue that might lead to stopped observers on some partitions.
• Support for manual checkpointing.
• Compatible with SQL .NET SDK versions 1.21 and above.

1.2.0

• Adds support for .NET Standard 2.0. The package now supports netstandard2.0 and net451 framework monikers.
• Compatible with SQL .NET SDK versions 1.17.0 and above.
• Compatible with SQL .NET Core SDK versions 1.5.1 and above.

1.1.1

• Fixes an issue with the calculation of the estimate of remaining work when the Change Feed was empty or no work was pending.
• Compatible with SQL .NET SDK versions 1.13.2 and above.

1.1.0

• Added a method to obtain an estimate of remaining work to be processed in the Change Feed.
• Compatible with SQL .NET SDK versions 1.13.2 and above.

1.0.0

• GA SDK
• Compatible with SQL .NET SDK versions 1.14.1 and below.

Release & Retirement dates

Microsoft will provide notification at least 12 months in advance of retiring an SDK in order to smooth the transition to a newer/supported version. New features and functionality and optimizations are only added to the current SDK, as such it is recommended that you always upgrade to the latest SDK version as early as possible.

Version	Release Date	Retirement Date
2.5.0	May 15, 2023	---
2.4.0	May 6, 2021	---
2.3.2	August 11, 2020	---
2.3.1	July 30, 2020	---
2.3.0	April 2, 2020	---
2.2.8	October 28, 2019	---
2.2.7	May 14, 2019	---
2.2.6	January 29, 2019	---
2.2.5	December 13, 2018	---
2.2.4	November 29, 2018	---
2.2.3	November 19, 2018	---
2.2.2	October 31, 2018	---
2.2.1	October 24, 2018	---
1.3.3	May 08, 2018	---
1.3.2	April 18, 2018	---
1.3.1	March 13, 2018	---
1.2.0	October 31, 2017	---
1.1.1	August 29, 2017	---
1.1.0	August 13, 2017	---
1.0.0	July 07, 2017	---

FAQ

How will I be notified of the retiring SDK?

Azure will provide 12 month's advance notice before the end of support of the retiring SDK to facilitate a smooth transition to a supported SDK. We'll notify you through various communication channels: the Azure portal, Azure updates, and direct communication to assigned service administrators.

Can I author applications by using a to-be-retired Azure Cosmos DB SDK during the 12-month period?

Yes, you'll be able to author, deploy, and modify applications by using the to-be-retired Azure Cosmos DB SDK during the 12-month notice period. We recommend that you migrate to a newer supported version of the Azure Cosmos DB SDK during the 12-month notice period, as appropriate.

After the retirement date, what happens to applications that use the unsupported Azure Cosmos DB SDK?

After the retirement date, Azure Cosmos DB will no longer make bug fixes, add new features, or provide support to the retired SDK versions. If you prefer not to upgrade, requests sent from the retired versions of the SDK will continue to be served by the Azure Cosmos DB service.

Which SDK versions will have the latest features and updates?

New features and updates will be added only to the latest minor version of the latest supported major SDK version. We recommend that you always use the latest version to take advantage of new features, performance improvements, and bug fixes. If you're using an old, non-retired version of the SDK, your requests to Azure Cosmos DB will still function, but you won't have access to any new capabilities.

What should I do if I can't update my application before a cutoff date?

We recommend that you upgrade to the latest SDK as early as possible. After an SDK is tagged for retirement, you'll have 12 months to update your application. If you're not able to update by the retirement date, requests sent from the retired versions of the SDK will continue to be served by Azure Cosmos DB, so your running applications will continue to function. But Azure Cosmos DB will no longer make bug fixes, add new features, or provide support to the retired SDK versions.

If you have a support plan and require technical support, contact us by filing a support ticket.

How can I request features be added to an SDK or connector?

New features are not always added to every SDK or connector immediately. If there is a feature not supported that you would like added, please add feedback to our community forum.

See also

To learn more about Azure Cosmos DB, see Azure Cosmos DB service page.