NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
NuGet
NuGet, #2094 most downloaded on NuGet
Ocelot is an API gateway based on ASP.NET Core stack.
Latest stable
25.0.2
Last release 1 months ago
15 Oct 2026
Release timing varies
gaps range from 8 days to 7 months
Most releases are documented
notes for 30 of 34 stable releases
512 versions withdrawn
withdrawn after publishing
127 years old
546 releases · first in 1900
Drag across the ruler to compare, or tap a release to open it.
Please note that some of the packages are deprecated! To watch the status of each package and its repository, go to the Release Radar status page.
<!-- {0} -> 25.0.2 {1} -> 25.0.1 Tag to substitute: 25.0.2 https://www.nuget.org/packages/Ocelot/25.0.2 -->
Version 25.0.2 includes upgraded solutions of all Ocelot packages based on .NET SDK 10.0.402, released on October 13, 2026. For more details about SDK 10.0.402 (also known as Runtime 10.0.13), see the .NET 10.0.13 Release Notes as part of the .NET 10 Release Notes.
Affected Milestones: .NET 10, Summer '25
Hotfixed versions: 24.1.0 ("Globality"), 25.0.0, 25.0.1 (".NET 10")
Read the Docs: Ocelot 25.0 with PDF
:fire: Hotfixed bugs are #2352 and #2428. A sincere and heartfelt "Thank You" goes to @xiexihui, @elenacalugaru, and @alin-popa for reporting these critical bugs. :heart: A special "Thank You" goes to Beka Mosulishvili (@bekammo) for the professional and timely contributions in pull requests #2427 and #2429.
<details><summary><b>Interface Breaking Changes</b>:</summary>
The IDownstreamRouteProvider.Get method now returns Response<Route> (previously Response<DownstreamRouteHolder>). The DownstreamRouteHolder class has been removed. Placeholders are now stored directly on Route.TemplatePlaceholderNameAndValues. Custom implementations of IDownstreamRouteProvider and any code that references DownstreamRouteHolder require updates and recompilation.
</details> <details><summary><b>Other changes affecting deployments</b>:</summary>
RegexParseException on certain browser headers such as sec-ch-ua). An empty collection is returned instead. Static routing is unchanged.</details>
<!--
net10.0, version 25.0) a.k.a. the .NET 10 releaseMilestone: .NET 10 :point_left: Codenamed: .NET 10 Read the Docs: Ocelot 25.0 with PDF Target Framework Monikers:
net8.0,net9.0,net10.0
On November 11th, 2025, the .NET team announced the release of the .NET 10 framework:
This major release upgrades the Ocelot package TFMs to net10.0 in addition to the current net8.0 and net9.0. Thus, the current Ocelot supported frameworks are .NET 8 LTS, .NET 9 STS, and .NET 10 LTS.
Additionally, in this major release the Ocelot team focused on preparing the codebase and its ecosystem for the .NET 10 SDK (.NET 10 milestone), while also extracting several integrated extension packages from the v24.1 monorepo into their own dedicated repositories to speed up delivery and reduce release coupling. As a result of these DevOps activities, the Ocelot repository now hosts only two package projects — Ocelot (src folder) and Ocelot.Testing (testing folder) — along with two solutions, Ocelot.slnx and Ocelot.Samples.slnx, which can be opened or built only if the .NET 10 SDK is installed. Since the extension packages now live in separate repositories, a new Release Radar status page has been introduced to track their progress.
This major version also includes the following feature updates:
ocelot.*.json files, keeping users' extended properties available during Ocelot app startup and at runtime via the standard IConfiguration service in the DI container.Finally, because the repository has a new folder structure, the development team recommends recloning or even reforking the Ocelot repository for a successful upgrade to the new version in order to avoid potential build errors.
As a best practice, the release strategy has been aligned with .NET SDK monthly patches (usually available between the 10th and 15th of each month). The development team will therefore also aim to roll out monthly Ocelot patches that reference the new .NET SDK patched versions. Ocelot patches will follow the form of a beta or patched version major.minor.*, where * is the Ocelot patch number corresponding to the newly available .NET SDK patch.
Ideally, the Ocelot team expects accelerated releases with more frequent minor/patch versions, because DevOps is now prepared for the new release strategy and offers fast delivery.
For successful contributions, maintainers will announce an identity-verification procedure (details for first-time contributors will be published soon).
:star: Quality of Service: A "Built-in Circuit Breaker" feature implementation was added by @ocelot-ot in pull request #2385 — no Polly required. :star:
Ocelot's QoS schema no longer strictly depends on the external Ocelot.QualityOfService.Polly package to provide circuit breaking and timeout enforcement.
A lightweight, thread-safe circuit breaker (Closed → Open → HalfOpen → Closed) ships in the Ocelot core package, supporting both count-based and FailureRatio-based modes.
The two implementations are mutually exclusive: the last of AddQualityOfService() or AddPolly() registered on the OcelotBuilder wins.
See the built-in QoS documentation for full details, including the AddQualityOfService<THandler>() extensibility point for overriding server error codes.
WebSockets: The "Overridable WebSocket buffer size" feature and custom middleware injection were added by @erannevo in pull request #2387.
The previously hard-coded DefaultWebSocketBufferSize is now a protected virtual property that can be overridden by subclassing.
The Middleware Injection feature was extended with a WebSocketsProxyMiddleware override on the OcelotPipelineConfiguration class, allowing a fully custom WebSocket middleware to be injected into the pipeline.
Refer to the "Sample" section to understand how to utilize the new feature.
WebSockets: The "SecurityOptions support for the WebSocket pipeline" feature was added by @CurtisRobertOliver in pull request #2406.
Previously, IP allow/block-list Routing "Security Options" were not enforced for WebSocket upgrade requests (a.k.a. the CONNECT HTTP method), allowing them to bypass IP security.
WebSocket upgrade requests are now intercepted by the same IPSecurityPolicy used for regular HTTP requests, and denied upgrades now correctly return 403 Forbidden.
:star: Configuration: The "Extend configuration with Custom Properties" feature was implemented by @jlukawska in pull request #1183. :star:
Ocelot's configuration builder now merges custom (non-schema) JSON properties defined across multiple ocelot.*.json files using Newtonsoft's JToken merge functionality, instead of the last-loaded file silently overwriting properties from previous files in the Routes collection.
This also applies to the DynamicRoutes collection and the GlobalConfiguration section. See the updated Configuration documentation, especially the "Extend configuration with Custom Properties" section, and the Configuration Sample app for details.
:airplane: Aggregation: A new "Manual/custom aggregators for Complex Aggregation" feature has been published (originally developed by @TomPallister in pull requests #248, #310). :airplane:
While working on bug #2248 in pull request #2328 by @NandanDevHub, the development team uncovered an undocumented feature in the Multiplexer namespace and decided to publish this pilot feature in the "Aggregate Manually?" documentation. The feature is based on the IResponseAggregator interface, whose correct application is currently unclear. The Ocelot team will test it further in upcoming releases, develop best practices, create a sample app, and inform the community. For this reason we warn that the feature is still in pilot status. :airplane:
Extension packages extraction #2334: The Ocelot team continued extracting integrated extension packages out of the monorepo into their own dedicated repositories, each with an independent release cycle:
Ocelot.Provider.Eureka, see issue #2371) in pull request #2372Ocelot.Provider.Polly, see issue #2378) in pull request #2380Ocelot.Provider.Consul, see issue #2378) in pull request #2388Ocelot.Provider.Kubernetes, see issue #2378) in pull request #2404This keeps the Ocelot core repository lean, avoids delays caused by the integrated packages' own release schedules, and lets each provider evolve independently. Consult the Caching, Tracing, Service Discovery, and Kubernetes chapters for package-specific upgrade notes. Please note that some of the packages are deprecated! To watch the status of each package and its repository, go to the Release Radar status page.
Kubernetes: The "PollKube provider" was redesigned by @raman-m in pull request #2358.
The PollKube discovery provider was redesigned to utilize PeriodicTimer (introduced in .NET 6). The provider is based on an "active polling" strategy that requires stable behavior and careful management of timing events in multi-threaded scenarios. The new PeriodicTimer is designed for thread safety, and its callbacks replace the old Timer callbacks, which work fine in a synchronous flow.
Please note that the PollKube discovery provider is now part of the Ocelot.Discovery.KubeClient package.
DevOps: Extensive testing and tooling modernization was carried out by contributors ahead of .NET 10 milestone:
.sln → .slnx), by @raman-m in pull request #2354.Microsoft.Testing.Platform framework (by @raman-m in #2392).coverlet.runsettings (by @ocelot-ot in #2365).10.0.* (.NET Runtime 10.0.*), by @raman-m and @ocelot-ot in pull requests #2367, #2389, #2402, and #2409.The updated documentation also highlights the deprecation of certain packages through multiple notes and warnings. With the Obsolete attributes in place, C# developers will notice several warnings in the build logs during compilation.
Routing: Issue #2346 was patched by @bhargav-polara in pull request #2351.
This fixes a bug where downstream URL query parameter names could be corrupted if they contained a placeholder with a non-empty value.
The DownstreamUrlCreatorMiddleware query-string merging algorithm was refactored to take full advantage of ASP.NET Core's QueryHelpers.
Error Handling: Issue #2376 was patched by @Majdi-Zlitni in pull request #2379.
Requests containing non-ASCII characters in HTTP header values previously surfaced as an unhandled HttpRequestException and an HTTP 502 Bad Gateway response.
Ocelot now catches this HttpRequestException and maps it to a 400 Bad Request response, in line with RFC 7230 "Field Parsing" rules.
:fire: WebSockets: Critical issue #2403 was patched by @CurtisRobertOliver in pull request #2406. :fire:
Previously, IP allow/block-list Routing "Security Options" were not enforced for WebSocket upgrade requests, allowing them to bypass IP security.
WebSocket upgrade requests are now intercepted by the same IPSecurityPolicy used for regular HTTP requests, and denied upgrades now correctly return 403 Forbidden.
This critical security issue was detected by security scanners on GitHub after the bug was reported. :see_no_evil: Many thanks to George Chen (@geo-chen) for reporting this critical bug.
Aggregation: Issue #2248 was patched by @NandanDevHub in pull request #2328.
Complex Aggregation routes configured with the RouteKeysConfig array now correctly map route keys to the corresponding aggregator context, fixing a bug where keys could be mismatched or dropped during multiplexing.
Administration: Issue #989 was patched by @mmustafasenoglu in pull request #2412.
The {adminPath}/configuration and {adminPath}/outputcache/{region} endpoints are now decorated with [ApiExplorerSettings(IgnoreApi = true)] so that they no longer appear in Swagger/OpenAPI documentation generated for the downstream API surface.
-->
<details><summary><b>Logbook</b></summary>
<details><summary><b>What's Changed</b></summary>
DownstreamUrlCreatorMiddleware to proxy the original upstream URL part as-is as the downstream path when routing dynamically by @bekammo in https://github.com/ThreeMammals/Ocelot/pull/2429
</details>Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/25.0.1...25.0.2
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Ocelot.* extension packagesOcelot.Cache.CacheManager version 25.0.2Ocelot.QualityOfService.Polly version 25.0.2Ocelot.Discovery.Consul version 25.0.2Ocelot.Discovery.Eureka version 25.0.2Ocelot.Discovery.KubeClient version 25.0.2Affected Milestones: .NET 10 , Summer '25 Hotfixed versions: 24.1.0 ("Globality"), 25.0.0 , 25.0.1 (".NET 10") Read the Docs: Ocelot 25.0 with PDF
🔥 Hotfixed bugs are #2352 and #2428 . A sincere and heartfelt "Thank You" goes to @xiexihui , @elenacalugaru , and @alin-popa for reporting these critical bugs. ❤️ A special "Thank You" goes to Beka Mosulishvili ( @bekammo ) for the professional and timely contributions in pull requests #2427 and #2429 .
Interface Breaking Changes :
Interface FQN: Ocelot.DownstreamRouteFinder.Finder.IDownstreamRouteProvider
Deleted type FQN: Ocelot.DownstreamRouteFinder.DownstreamRouteHolder
The IDownstreamRouteProvider.Get method now returns Response<Route> (previously Response<DownstreamRouteHolder> ). The DownstreamRouteHolder class has been removed. Placeholders are now stored directly on Route.TemplatePlaceholderNameAndValues . Custom implementations of IDownstreamRouteProvider and any code that references DownstreamRouteHolder require updates and recompilation. Other changes affecting deployments :
Dynamic Routing no longer attempts to build upstream header templates from incoming request headers (fixes RegexParseException on certain browser headers such as sec-ch-ua ). An empty collection is returned instead. Static routing is unchanged.
Reference updated to .NET SDK 10.0.402 / Runtime 10.0.13 .
Logbook
57b953e by Raman Maksimchuk on Thursday, October 15 at 19:32 → Release version 25.0.2 for SDK 10.0.402 | Dynamic Routing patch | +semver: patch
268fbb4 by Raman Maksimchuk on Thursday, October 15 at 14:45 → Ref SDK 10.0.402 (Runtime 10.0.13) to release Ocelot v25.0.2 and Ocelot.Testing v25.0.2
fda3a29 by Beka Mosulishvili on Wednesday, October 07 at 22:54 → #2428 Update DownstreamUrlCreatorMiddleware to proxy the original upstream URL part as-is as the downstream path when routing dynamically ( #2429 )
b391b14 by bekammo on Wednesday, September 30 at 15:11 → #2352 Stop building upstream header templates from request headers in dynamic routing ( #2427 ) What's Changed
#2352 Stop building upstream header templates from request headers in dynamic routing by @bekammo in #2427
#2428 Update DownstreamUrlCreatorMiddleware to proxy the original upstream URL part as-is as the downstream path when routing dynamically by @bekammo in #2429
Full Changelog : 25.0.1...25.0.2
alin-popa, xiexihui, and 2 other contributors
Assets 7 Loading
There was an error while loading. Please reload this page .
All reactions
You can’t perform that action at this time.
Ocelot.Discovery.KubeClient version 25.0.1
Ocelot.* extension packagesOcelot.QualityOfService.Polly version 25.0.1Ocelot.Discovery.Consul version 25.0.1.2Ocelot.Discovery.Eureka version 25.0.1Ocelot.Discovery.KubeClient version 25.0.1[!WARNING]
Critical Hotfix for Dynamic Routing users. Please upgrade to 25.0.2 ASAP❗
If your Ocelot deployment uses the Dynamic Routing feature, you are affected by two critical bugs — #2352 and #2428 — and must upgrade to 25.0.2 immediately. Users not using Dynamic Routing can safely remain on 24.1.0 (.NET 9); 25.0.0, 25.0.1 (.NET 10).
Version 25.0.1 includes upgraded solutions of all Ocelot packages based on .NET SDK 10.0.401, released on September 8, 2026. For more details about SDK 10.0.401 a.k.a. Runtime 10.0.12, see the .NET 10.0.12 Release Notes as part of .NET 10 Release Notes.
<details><summary><b>Logbook</b></summary>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/25.0.0...25.0.1
Please note that some of the packages are deprecated! To watch the status of each package and its repository, go to the Release Radar status page.
[!WARNING]
Critical Hotfix for Dynamic Routing users. Please upgrade to 25.0.2 ASAP❗
If your Ocelot deployment uses the Dynamic Routing feature, you are affected by two critical bugs — #2352 and #2428 — and must upgrade to 25.0.2 immediately. Users not using Dynamic Routing can safely remain on 24.1.0 (.NET 9); 25.0.0, 25.0.1 (.NET 10).
<!-- {0} -> 25.0.0 {1} -> 24.1.0 Tag to substitute: 25.0.0 https://www.nuget.org/packages/Ocelot/25.0.0 -->
net10.0, version 25.0) a.k.a. the .NET 10 releaseMilestone: .NET 10 :point_left: Codenamed: .NET 10 Read the Docs: Ocelot 25.0 with PDF Target Framework Monikers:
net8.0,net9.0,net10.0
On November 11th, 2025, the .NET team announced the release of the .NET 10 framework:
This major release upgrades the Ocelot package TFMs to net10.0 in addition to the current net8.0 and net9.0. Thus, the current Ocelot supported frameworks are .NET 8 LTS, .NET 9 STS, and .NET 10 LTS.
Additionally, in this major release the Ocelot team focused on preparing the codebase and its ecosystem for the .NET 10 SDK (.NET 10 milestone), while also extracting several integrated extension packages from the v24.1 monorepo into their own dedicated repositories to speed up delivery and reduce release coupling. As a result of these DevOps activities, the Ocelot repository now hosts only two package projects — Ocelot (src folder) and Ocelot.Testing (testing folder) — along with two solutions, Ocelot.slnx and Ocelot.Samples.slnx, which can be opened or built only if the .NET 10 SDK is installed. Since the extension packages now live in separate repositories, a new Release Radar status page has been introduced to track their progress.
This major version also includes the following feature updates:
ocelot.*.json files, keeping users' extended properties available during Ocelot app startup and at runtime via the standard IConfiguration service in the DI container.Finally, because the repository has a new folder structure, the development team recommends recloning or even reforking the Ocelot repository for a successful upgrade to the new version in order to avoid potential build errors.
As a best practice, the release strategy has been aligned with .NET SDK monthly patches (usually available between the 10th and 15th of each month). The development team will therefore also aim to roll out monthly Ocelot patches that reference the new .NET SDK patched versions. Ocelot patches will follow the form of a beta or patched version major.minor.*, where * is the Ocelot patch number corresponding to the newly available .NET SDK patch.
Ideally, the Ocelot team expects accelerated releases with more frequent minor/patch versions, because DevOps is now prepared for the new release strategy and offers fast delivery.
For successful contributions, maintainers will announce an identity-verification procedure (details for first-time contributors will be published soon).
<details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/qualityofservice.rst">Quality of Service</a></b>: A "<a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/qualityofservice.rst#built-in-qos">Built-in Circuit Breaker</a>" feature <a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/qualityofservice.rst#implementations-overview">implementation</a> was added by @ocelot-ot in pull request #2385 — no <a href="https://www.nuget.org/packages/Polly/">Polly</a> required. :star: </summary>
Ocelot's QoS schema no longer strictly depends on the external Ocelot.QualityOfService.Polly package to provide circuit breaking and timeout enforcement. A lightweight, thread-safe circuit breaker (Closed → Open → HalfOpen → Closed) ships in the Ocelot core package, supporting both count-based and FailureRatio-based modes.
The two implementations are mutually exclusive: the last of AddQualityOfService() or AddPolly() registered on the OcelotBuilder wins.
See the built-in QoS documentation for full details, including the AddQualityOfService<THandler>() extensibility point for overriding server error codes.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/websockets.rst">WebSockets</a></b>: The "<a href="https://github.com/ThreeMammals/Ocelot/issues/2386">Overridable WebSocket buffer size</a>" feature and custom middleware injection were added by @erannevo in pull request #2387.</summary>
The previously hard-coded DefaultWebSocketBufferSize is now a protected virtual property that can be overridden by subclassing.
The Middleware Injection feature was extended with a WebSocketsProxyMiddleware override on the OcelotPipelineConfiguration class, allowing a fully custom WebSocket middleware to be injected into the pipeline.
Refer to the "Sample" section to understand how to utilize the new feature.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/websockets.rst">WebSockets</a></b>: The "<a href="https://github.com/ThreeMammals/Ocelot/issues/2403">SecurityOptions support for the WebSocket pipeline</a>" feature was added by @CurtisRobertOliver in pull request #2406.</summary>
Previously, IP allow/block-list Routing "Security Options" were not enforced for WebSocket upgrade requests (a.k.a. the CONNECT HTTP method), allowing them to bypass IP security. WebSocket upgrade requests are now intercepted by the same IPSecurityPolicy used for regular HTTP requests, and denied upgrades now correctly return 403 Forbidden.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/configuration.rst">Configuration</a></b>: The "<a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/configuration.rst#extend-with-custom-properties">Extend configuration with Custom Properties</a>" feature was implemented by @jlukawska in pull request #1183. :star: </summary>
Ocelot's configuration builder now merges custom (non-schema) JSON properties defined across multiple ocelot.*.json files using Newtonsoft's JToken merge functionality, instead of the last-loaded file silently overwriting properties from previous files in the Routes collection.
This also applies to the DynamicRoutes collection and the GlobalConfiguration section. See the updated Configuration documentation, especially the "Extend configuration with Custom Properties" section, and the Configuration Sample app for details.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/aggregation.rst">Aggregation</a></b>: A new "<a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/aggregation.rst#aggregate-manually">Manual (custom) aggregators</a> for <a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/aggregation.rst#complex-aggregation">Complex Aggregation</a>" feature has been published (originally developed by @TomPallister in pull requests #248, #310). :airplane: </summary>
While working on bug #2248 in pull request #2328 by @NandanDevHub, the development team uncovered an undocumented feature in the Multiplexer namespace and decided to publish this pilot feature in the "Aggregate Manually?" documentation. The feature is based on the IResponseAggregator interface, whose correct application is currently unclear.
The Ocelot team will test it further in upcoming releases, develop best practices, create a sample app, and inform the community. For this reason we warn that the feature is still in pilot status. :airplane:
</details>
<details> <summary><b><a href="https://www.nuget.org/profiles/ThreeMammals">Extension packages</a></b> extraction #2334.</summary>
The Ocelot team continued extracting integrated extension packages out of the monorepo into their own dedicated repositories, each with an independent release cycle:
Ocelot.Provider.Eureka, see issue #2371) in pull request #2372Ocelot.Provider.Polly, see issue #2378) in pull request #2380Ocelot.Provider.Consul, see issue #2378) in pull request #2388Ocelot.Provider.Kubernetes, see issue #2378) in pull request #2404This keeps the Ocelot core repository lean, avoids delays caused by the integrated packages' own release schedules, and lets each provider evolve independently. Consult the Caching, Tracing, Service Discovery, and Kubernetes chapters for package-specific upgrade notes. Please note that some of the packages are deprecated! To watch the status of each package and its repository, go to the Release Radar status page.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/kubernetes.rst">Kubernetes</a></b>: The "<a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/kubernetes.rst#pollkube-provider-3">PollKube provider</a>" was redesigned by @raman-m in pull request #2358.</summary>
The PollKube discovery provider was redesigned to utilize PeriodicTimer (introduced in .NET 6). The provider is based on an "active polling" strategy that requires stable behavior and careful management of timing events in multi-threaded scenarios. The new PeriodicTimer is designed for thread safety, and its callbacks replace the old Timer callbacks, which work fine in a synchronous flow.
Please note that the PollKube discovery provider is now part of the Ocelot.Discovery.KubeClient package.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/labels/DevOps">DevOps</a></b>: Extensive testing and tooling modernization was carried out by contributors ahead of <a href="https://github.com/ThreeMammals/Ocelot/milestone/13">.NET 10</a> milestone.</summary> </br>
.sln → .slnx), by @raman-m in pull request #2354.Microsoft.Testing.Platform framework (by @raman-m in #2392).coverlet.runsettings (by @ocelot-ot in #2365).10.0.* (.NET Runtime 10.0.*), by @raman-m and @ocelot-ot in pull requests #2367, #2389, #2402, and #2409.The updated documentation also highlights the deprecation of certain packages through multiple notes and warnings. With the Obsolete attributes in place, C# developers will notice several warnings in the build logs during compilation. </details>
<details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/routing.rst">Routing</a></b>: Issue #2346 was patched by @bhargav-polara in pull request #2351.</summary>
This fixes a bug where downstream URL query parameter names could be corrupted if they contained a placeholder with a non-empty value.
The DownstreamUrlCreatorMiddleware query-string merging algorithm was refactored to take full advantage of ASP.NET Core's QueryHelpers.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/errorcodes.rst">Error Handling</a></b>: Issue #2376 was patched by @Majdi-Zlitni in pull request #2379.</summary>
Requests containing non-ASCII characters in HTTP header values previously surfaced as an unhandled HttpRequestException and an HTTP 502 Bad Gateway response.
Ocelot now catches this HttpRequestException and maps it to a 400 Bad Request response, in line with RFC 7230 "Field Parsing" rules.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/websockets.rst">WebSockets</a></b>: Critical issue #2403 was patched by @CurtisRobertOliver in pull request #2406. :fire: </summary>
Previously, IP allow/block-list Routing "Security Options" were not enforced for WebSocket upgrade requests, allowing them to bypass IP security. WebSocket upgrade requests are now intercepted by the same IPSecurityPolicy used for regular HTTP requests, and denied upgrades now correctly return 403 Forbidden.
This critical security issue was detected by security scanners on GitHub after the bug was reported. :see_no_evil:
Many thanks to George Chen (@geo-chen) for reporting this critical bug.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/aggregation.rst">Aggregation</a></b>: Issue #2248 was patched by @NandanDevHub in pull request #2328.</summary>
Complex Aggregation routes configured with the RouteKeysConfig array now correctly map route keys to the corresponding aggregator context, fixing a bug where keys could be mismatched or dropped during multiplexing.
</details> <details> <summary><b><a href="https://github.com/ThreeMammals/Ocelot/blob/25.0.0/docs/features/administration.rst">Administration</a></b>: Issue #989 was patched by @mmustafasenoglu in pull request #2412.</summary>
The {adminPath}/configuration and {adminPath}/outputcache/{region} endpoints are now decorated with [ApiExplorerSettings(IgnoreApi = true)] so that they no longer appear in Swagger/OpenAPI documentation generated for the downstream API surface.
</details>
1<sup>st</sup> :1st_place_medal: goes to Ocelot Robot for delivering 3 features 2<sup>nd</sup>:2nd_place_medal: goes to Jolanta Łukawska for delivering 1 feature in 32 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Eran Nevo for delivering 1 feature in 21 files changed 4<sup>th</sup> :orange_heart: goes to Majdi Zlitni for delivering 1 feature in 17 files changed 5<sup>th</sup> :yellow_heart: goes to Curtis Oliver for delivering 1 feature in 15 files changed
:star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star: Raman Maksimchuk :star::star::star::star::star::star::star: Ocelot Robot, @ocelot-ot :star: Jolanta Łukawska, @jlukawska :star: Eran Nevo, @erannevo :star: Majdi Zlitni, @Majdi-Zlitni :star: Curtis Oliver, @CurtisRobertOliver :star: Methran G., @methran1304 :star: Nandan Parmar, @NandanDevHub :star: Bhargav Polara, @bhargav-polara :star: Mustafa Şenoğlu, @mmustafasenoglu :star: Miňo Martiniak, @Burgyn
<details><summary><b>Logbook</b></summary>
MMLib.SwaggerForOcelot package to the Introduction "Not Supported" chapter (#1429)SecurityOptions support to the WebSocket pipeline (#2406)FileConfigurationPoller against timer reentrancy and callback thread leaks, and stabilize TimeoutDelegatingHandler timeout test (#2394)HttpRequestException to 400 Bad Request according to RFC 7230 (#2379)</details>
<details><summary><b>What's Changed</b></summary>
PollKube discovery using PeriodicTimer by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2358Ocelot.Cache.CacheManager project in favor of a dedicated repository by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2360Ocelot.Tracing.Butterfly project in favor of a dedicated repository by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2361Ocelot.Tracing.OpenTracing project in favor of a dedicated repository by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2362Ocelot.Testing back into the Ocelot mono-repo by @ocelot-ot in https://github.com/ThreeMammals/Ocelot/pull/2364Ocelot.Testing from Cobertura coverage via Coverlet .runsettings by @ocelot-ot in https://github.com/ThreeMammals/Ocelot/pull/2365Ocelot.Provider.Eureka project in favor of a dedicated repository by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2372HttpRequestException to 400 Bad Request according to RFC 7230 by @Majdi-Zlitni in https://github.com/ThreeMammals/Ocelot/pull/2379Ocelot.Provider.Polly project in favor of a dedicated repository by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2380Ocelot.Provider.Consul project in favor of a dedicated repository by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2388Microsoft.Testing.Platform framework & xUnit v3 for acceptance testing by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2392FileConfigurationPoller against timer reentrancy and callback thread leaks, and stabilize TimeoutDelegatingHandler timeout test by @ocelot-ot in https://github.com/ThreeMammals/Ocelot/pull/2394Kube provider, repository FileConfigurationPoller, and infrastructure InMemoryBus, and stabilize their tests by @ocelot-ot in https://github.com/ThreeMammals/Ocelot/pull/2399Ocelot v25 beta 4 and Ocelot.Testing v25 beta 10+ by @ocelot-ot in https://github.com/ThreeMammals/Ocelot/pull/2402Ocelot.Provider.Kubernetes project in favor of a dedicated repository by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2404SecurityOptions support to the WebSocket pipeline by @CurtisRobertOliver in https://github.com/ThreeMammals/Ocelot/pull/2406RouteKeysConfig arrays in aggregates by @NandanDevHub in https://github.com/ThreeMammals/Ocelot/pull/2328MMLib.SwaggerForOcelot package to the Introduction "Not Supported" chapter by @Burgyn in https://github.com/ThreeMammals/Ocelot/pull/1429ocelot.X.json configuration files using Newtonsoft's JToken merge functionality by @jlukawska in https://github.com/ThreeMammals/Ocelot/pull/1183Ocelot v25 beta 4 and Ocelot.Testing v25 beta 10+ by @ocelot-ot in https://github.com/ThreeMammals/Ocelot/pull/2409.md doc with dynamic package badges by @ocelot-ot in https://github.com/ThreeMammals/Ocelot/pull/240825.0.0-beta.4 tag by @ocelot-ot in https://github.com/ThreeMammals/Ocelot/pull/2413net10.0 TFM | .NET 10 release by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2415</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/24.1.0...25.0.0
The updated documentation highlights the deprecation of certain options through multiple notes and warnings. This deprecation process will be complete…
[!WARNING]
Critical Hotfix for Dynamic Routing users. Please upgrade to 25.0.2 ASAP❗
If your Ocelot deployment uses the Dynamic Routing feature, you are affected by two critical bugs — #2352 and #2428 — and must upgrade to 25.0.2 immediately. Users not using Dynamic Routing can safely remain on 24.1.0 (.NET 9); 25.0.0, 25.0.1 (.NET 10).
Milestone: Summer'25 :point_left: Codenamed: Globality Read the Docs: Ocelot 24.1 with PDF
In this minor release, the Ocelot team put the spotlight on the Configuration feature as part of their semi-annual 2025 effort, with a particular focus on the Global Configuration Schema. This release enhances support for global configurations across both routing modes: the classic static Routing and the service discovery-based Dynamic Routing.
The updated documentation highlights the deprecation of certain options through multiple notes and warnings. This deprecation process will be completed in the upcoming .NET 10 release. With the [Obsolete] attributes in place, C# developers will notice several warnings in the build logs during compilation.
On top of that, this release brings a great enhancement to the Kubernetes provider, also known as the Ocelot.Provider.Kubernetes package.
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/configuration.rst">Configuration</a></b>: The "<a href="https://github.com/ThreeMammals/Ocelot/issues/585">Dynamic routing global configuration</a>" feature has been redesigned by @raman-m and contributors.</summary><br/>
This update brings changes to the Dynamic Route Schema and Global Configuration Schema, while the Route Schema stays the same apart from deprecation updates. All work was coordinated under issue #585, which addressed the challenges of configuring Ocelot's most popular features globally before version 24.1, when dynamic routing gained global configuration partial support, but static routing mostly lacked it. A key outcome of #585 is the ability to override global configuration options within the DynamicRoutes collection. This ongoing issue will continue to require attention, as adapting static route global configurations for dynamic routing is complex and, in some cases, impossible. This will be a challenge for future Ocelot releases and the community.
</details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/kubernetes.rst">Kubernetes</a></b>: The "<a href="https://github.com/ThreeMammals/Ocelot/discussions/2168">Kubernetes provider based on watch requests</a>" feature by @kick2nick in PR #2174. :star: </summary><br/>
The Ocelot.Provider.Kubernetes package now features a new WatchKube provider for Kubernetes service discovery. This provider is a great fit for high-load environments where the older Kube and PollKube providers struggle to handle heavy traffic, often leading to increased log errors, HTTP 500 issues, and potential Ocelot instance failures. WatchKube is the next step in the evolution of these providers, leveraging the reactive capabilities of the KubeClient API. For guidance on choosing the right provider for your Kubernetes setup, check out the "Comparing providers" section in the documentation.
</details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/configuration.rst">Configuration</a></b>: The "<a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/configuration.rst#timeout">Routing default timeout</a>" feature by @hogwartsdeveloper in PR #2073.</summary><br/>
In the past, the Timeout setting in the Route Schema didn't actually stop requests, defaulting instead to a fixed 90 seconds. Custom timeouts were handled using the Quality of Service Timeout strategy, and this only applied if Polly and the Ocelot.Provider.Polly package were used. Now, the Timeout option (in seconds) can be set at the route, global, and QoS levels. The Global Configuration Schema and Dynamic Route Schema also include the new Timeout setting, making it possible to configure default timeouts for dynamic routing as well.
</details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/qualityofservice.rst">Quality of Service</a></b>: The "<a href="https://github.com/ThreeMammals/Ocelot/issues/2080">FailureRatio and SamplingDuration parameters of Polly V8 circuit-breaker</a>" feature by @RaynaldM in PR #2081.</summary><br/>
Starting with version 24.1, two new parameters in QoSOptions, FailureRatio and SamplingDuration, let you fine-tune the behavior of the Circuit Breaker strategy. Both can be configured globally, even with dynamic routing.
Please note that DurationOfBreak, ExceptionsAllowedBeforeBreaking, and TimeoutValue are now deprecated in 24.1, so check the QoSOptions Schema documentation for details.
</details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/configuration.rst">Configuration</a></b>: Several <a href="https://github.com/ThreeMammals/Ocelot/tree/24.1.0/src/Ocelot/Configuration/File">File-model</a> options have been deprecated by @raman-m.</summary><br/>
The updated docs now highlight these deprecated options with multiple notes and warnings. The v24.1 deprecation process will wrap up in the upcoming .NET 10 release. Due to the Obsolete attributes, C# developers will notice several build warnings during compilation.
</details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/tree/main/test">Testing</a></b>: The <a href="https://github.com/ThreeMammals/Ocelot/tree/24.0.0/test/Ocelot.Testing">Ocelot.Testing</a> project was deprecated by @raman-m in PR #2295.</summary><br/>
The project was removed from the main repo and moved to its own Ocelot.Testing repository. This change allows the Ocelot.Testing package to be shared independently for extension package delivery. The Ocelot team also plans to deprecate more projects and move them to separate repos because: a) despite the fact that a monorepo enables faster builds and quicker delivery; b) but the release process can be delayed by missing versions of integrated libraries in extension packages. The goal is for the Ocelot repo to only contain essential projects, avoiding delays caused by integrated package release schedules. Legacy or abandoned integrated packages should be deprecated and maintained in their own repos with independent release cycles. </details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/headerstransformation.rst">Headers Transformation</a></b>: Added <a href="https://github.com/ThreeMammals/Ocelot/issues/1658">global configuration</a> by @marklonquist in PR #1659.</summary><br/>
The Global Configuration Schema now includes new DownstreamHeaderTransform and UpstreamHeaderTransform options. These work only with static routes, meaning the Routes collection (see Route Schema). They aren't supported for dynamic routes because they're not part of the Dynamic Route Schema, and Ocelot Core doesn't read global configuration of this feature in dynamic routing mode. This is noted in the Roadmap documentation.
</details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/authentication.rst">Authentication</a></b>: Added <a href="https://github.com/ThreeMammals/Ocelot/issues/842">global configuration</a> by @jlukawska in PR #2114.</summary><br/>
The Global Configuration Schema now includes a new AuthenticationOptions property for setting up static routes globally. This also introduces the AllowAnonymous boolean option within AuthenticationOptions to control static route authentication. Later, PR #2336 extended global authentication support to dynamic routes.
Note: The AuthenticationProviderKey option is deprecated in version 24.1—see the AuthenticationOptions Schema documentation for details.
</details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/ratelimiting.rst">Rate Limiting</a></b>: Re-designed <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/ratelimiting.rst#configuration">global configuration</a> by @MiladRv and @raman-m in PR #2294.</summary><br/>
The Global Configuration Schema now includes a new RateLimitOptions property for both static and dynamic routes. Previously, global configuration was available through RateLimitOptions in dynamic routing mode, while route overriding used the now-deprecated RateLimitRule from the Dynamic Route Schema.
This marks the second major overhaul of the Rate Limiting feature since the first update in PR #1592. A new Wait option has been added, replacing the deprecated PeriodTimespan, to enhance the Fixed Window algorithm. The full list of deprecated options can be found in the Deprecated Options documentation.
</details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/loadbalancer.rst">Load Balancer</a></b>: Added <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/loadbalancer.rst#global-configuration-2">global configuration</a> by @raman-m in PR #2324.</summary><br/>
The Global Configuration Schema now includes a new LoadBalancerOptions property for both static and dynamic routes. Previously, global configuration was available through LoadBalancerOptions in dynamic routing mode without dynamic route overrides. Starting with version 24.1, the Dynamic Route Schema also supports LoadBalancerOptions for overriding, and global configuration for static routes is now supported as well.
</details>
<details> <summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/caching.rst">Caching</a></b>: Added <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/caching.rst#global-configuration-3">global configuration</a> by @raman-m in PR #2331.</summary><br/>
The Global Configuration Schema now includes a new CacheOptions property for both static and dynamic routes. Global configuration has been available for static routes since version 23.3, but starting with version 24.1, the Dynamic Route Schema also supports CacheOptions for overriding.
Note that the FileCacheOptions property in the Route Schema (static routes) is deprecated in version 24.1. For more details, see the caching Configuration documentation.
</details>
<details><summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/configuration.rst#httphandleroptions">Http Handler</a></b>: Added <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/configuration.rst#httphandleroptions">global configuration</a> by @raman-m in PR #2332.</summary><br/>
The Global Configuration Schema now includes a new HttpHandlerOptions property for both static and dynamic routes. Previously, global configuration was available through HttpHandlerOptions in dynamic routing mode without dynamic route overriding. Starting with version 24.1, the Dynamic Route Schema also supports HttpHandlerOptions for overriding, and global configuration is now available for static routes as well.
</details>
<details><summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/authentication.rst">Authentication</a></b>: Added <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/authentication.rst#global-configuration-4">global configuration</a> by @raman-m in PR #2336.</summary><br/>
The Global Configuration Schema now includes a new AuthenticationOptions property for both static and dynamic routes. Starting with version 24.1, the Dynamic Route Schema also supports AuthenticationOptions to override global settings.
Note that the AuthenticationProviderKey option is deprecated in version 24.1, so check the AuthenticationOptions Schema documentation for details.
</details>
<details><summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/qualityofservice.rst">Quality of Service</a></b>: Added <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/qualityofservice.rst#global-configuration-3">global configuration</a> by @raman-m in PR #2339.</summary><br/>
The Global Configuration Schema now includes a new QoSOptions property for both static and dynamic routes. Previously, global configuration was available through QoSOptions in dynamic routing mode without the option for dynamic route overrides. Starting with version 24.1, the Dynamic Route Schema supports QoSOptions for overriding, and global configuration support is now available for static routes as well.
Note that the DurationOfBreak, ExceptionsAllowedBeforeBreaking, and TimeoutValue options are deprecated in version 24.1. For details, see the QoSOptions Schema documentation.
</details>
<details><summary><b> <a href="https://github.com/ThreeMammals/Ocelot/labels/DevOps">DevOps</a></b>: Stabilized tests and reviewed GH-Actions workflows by @raman-m in PRs #2342 and #2345.</summary><br/>
These efforts kept the CI/CD builds in GitHub Actions stable, targeting the beta release of version 24.1. The CI/CD environment was set up and tested GH-Actions workflows in advance for the beta release, which is the goal of PR #2347. </details>
<details><summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/websockets.rst">Websockets</a></b>: Issue #930 patch by @hogwartsdeveloper in PR #2091.</summary>
This update removes the troublesome System.Net.WebSockets.WebSocketException from logs, preventing Ocelot from running into 500 status disasters. The issue stemmed from client-side or network events that Ocelot's WebSocketsProxyMiddleware couldn't anticipate on the server side. The patch now checks for incorrect connection statuses, attempting to close the connection and end server-side tasks gracefully without errors.
</details>
<details><summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/kubernetes.rst">Kubernetes</a></b>: Issue #2304 patch by @raman-m in PR #2335.</summary>
This update fixes the PollKube provider to address a bug with the first cold request, where the winning thread got an empty collection before the initial callback was triggered. The solution is to call the integrated discovery provider for the first cold request when the queue is empty.
</details>
<details><summary><b> <a href="https://github.com/ThreeMammals/Ocelot/blob/main/docs/features/authorization.rst">Authorization</a></b>: Issue #913 patch by @mehyaa in PR #1478.</summary>
Starting with version 24.1, Ocelot now supports RFC 8693 (OAuth 2.0 Token Exchange) for the scope claim in the ScopesAuthorizer service, also referred to as the IScopesAuthorizer service in the DI container.
</details>
1<sup>st</sup> :1st_place_medal: goes to Zhannur Akhmetkhanov for delivering 2 features 2<sup>nd</sup> :2nd_place_medal: goes to Milad Rivandi for delivering 1 feature in 136 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Jolanta Łukawska for delivering 1 feature in 39 files changed
:star::star::star::star::star::star::star::star::star::star::star::star::star::star::star::star: Raman Maksimchuk, @raman-m :star::star: Zhannur Akhmetkhanov, @hogwartsdeveloper :star: Milad Rivandi, @MiladRv :star: Jolanta Łukawska, @jlukawska :star: Nikolay Kuksov, @kick2nick :star: Mehmet Yasin Akar, @mehyaa :star: Harris Zhang, @harris2012 :star: Mark Bøg Lønquist, @marklonquist :star: Raynald Messié, @RaynaldM
<details><summary><b>Logbook</b></summary>
WatchKube provider for Kubernetes service discovery (#2174)develop
</details><details><summary><b>What's Changed</b></summary>
WatchKube provider for Kubernetes service discovery by @kick2nick in https://github.com/ThreeMammals/Ocelot/pull/2174FailureRatio and SamplingDuration V8 parameters to fine-tune Polly's circuit-breaker strategy via route-level and global QoS options by @RaynaldM in https://github.com/ThreeMammals/Ocelot/pull/2081AllowAnonymous authentication option with global AuthenticationOptions configuration by @jlukawska in https://github.com/ThreeMammals/Ocelot/pull/2114ConcurrentQueue<T> for managing service versions during polling by the PollKube discovery provider by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2335Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/24.0.1...24.1.0
Upgrade to .NET 9 with supported TFMs (net8.0;net9.0)
Upgrade to .NET 9 with supported TFMs (net8.0;net9.0)
Ocelot release: 24.0.0
Ocelot.Administration.IdentityServer4 release: 24.0.1
NuGet package: Ocelot.Administration.IdentityServer4.24.0.1
The Ocelot.Administration extension package has been renamed to Ocelot.Administration.IdentityServer4 ❗
All IdentityServer4-related vulnerabilities (issue #2218) were addressed. The Ocelot.Administration source code has been moved out of the Ocelot repository (pull request #2274) and transferred to the Ocelot.Administration.IdentityServer4 repository.
Currently, the Administration feature is solely based on the IdentityServer4 package, whose repository was archived by its owner on July 31, 2024. In this release, the Ocelot team deprecated the Ocelot.Administration.IdentityServer4 extension package after the current Ocelot v24.0 release; however, the repository is/will not be archived, allowing for potential patches in the future.
Note: In upcoming releases, the Ocelot team plans to utilize the ASP.NET Core Identity framework for Administration feature development and in Ocelot's acceptance testing project to align with .NET industry standards. As a result, the IdentityServer4 library is intended to be replaced with ASP.NET Core Identity, which also supports Bearer tokens, commonly known as
JwtBearerHandlerfrom the Microsoft.AspNetCore.Authentication.JwtBearer namespace.
Milestone: .NET 9 Hot fixed version: 24.0.0 Read the Docs: Ocelot 24.0 with PDF
:fire: Hot fixed bug: #2299 :heart: A sincere and heartfelt "Thank You" to Gracjan Bryłka, @font3r for reporting the bug.
Interface Breaking Changes:
IKubeApiClientFactory interface removal: The ServiceAccountPath property was removed because it was not intended for public use.
Interface FQN: Ocelot.Provider.Kubernetes.Interfaces.IKubeApiClientFactory
Property FQN: Ocelot.Provider.Kubernetes.Interfaces.IKubeApiClientFactory.ServiceAccountPathServiceAccountPath as a protected property of the factory to stabilize KubeApiClient creation in the Kubernetes provider by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2302Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/24.0.0...24.0.1
Upgrade to .NET 9 with supported TFMs (net8.0;net9.0)
Upgrade to .NET 9 with supported TFMs (net8.0;net9.0)
[!WARNING]
Critical Hotfix for Kubernetes users. Please upgrade to 24.0.1 ASAP❗
If your Ocelot deployment uses the Kubernetes feature, you are affected by critical bug — #2299 — and must upgrade to 24.0.1 immediately. Users not using Kubernetes can safely remain on 24.0.0 (.NET 9).
net9.0, version 24.0) a.k.a. the .NET 9 releaseMilestone: .NET 9 👈 Codenamed: .NET 9 Read the Docs: Ocelot 24.0 with PDF Target Framework Monikers:
net8.0,net9.0
On November 12th, 2024, the .NET team announced the release of the .NET 9 framework:
This major release upgrades Ocelot package TFMs to net9.0 in addition to the current net8.0. Thus, the current Ocelot supported frameworks are .NET 8 LTS and .NET 9 STS. According to the .NET Support Policy, the Ocelot team has discontinued support of .NET 6 and .NET 7 by providing the version 23.4.3 which targets those .NET versions.
Ocelot's previous CI/CD provider, CircleCI, facilitated professional and seamless development, build processes, and delivery of Ocelot versions for seven years, starting in March 2018. But last year, in January 2025, after patching Ocelot with version 23.4.3, our team encountered legal issues related to CircleCI Co's policies, leading to this CI/CD provider stopping the build process for the Ocelot project. This legal issue and technical incident were unforeseen on our part because Ocelot is open-source software (OSS), and forcibly stopping the project's build process and blocking accounts appears to be an unfortunate breach of OSS principles. We strongly believe that any developer or user, from any country, should be able to use software providers that support the OSS movement by offering free or other cost-free plans and serving the accounts of these users, OSS teams, and OSS projects 24/7, 365 days a year. We consider this legal issue and the resulting technical incidents involving CircleCI to be a serious breach of OSS principles and an act of discrimination against Ocelot users, developers, and customers who rely on Ocelot OSS, ultimately causing delays to the current release. As a team, we do not recommend using CircleCI for OSS projects, as there is no guarantee that these projects will not face discrimination from this U.S. company.
For all developers, team leads, architects, and managers of any OSS projects—at least on GitHub—we recommend utilizing the built-in GitHub Actions CI/CD infrastructure. Since its founding, GitHub has supported OSS projects. Today, GitHub provides 2,000 minutes of free CI/CD build time per month for OSS repositories (public repos). Also, we strongly believe that GitHub will never violate its OSS policies without a notice period, nor fail to inform owners and maintainers that certain policies must be met by Ocelot's owners. In addition, we want to acknowledge that we are monitoring U.S. government regulations. Unfortunately, we must state that some GitHub products are unavailable in certain countries, even if the project is OSS and GitHub claims these products are free for OSS. Since the Ocelot team does not utilize these non-critical products (we prefer to energize our brains rather than rely on AI-driven products), and since the Ocelot project is currently well-served by GitHub Co, the Ocelot team affirms that Ocelot will remain on GitHub as long as its OSS-friendly policies continue. As a team, we hope that GitHub will never enforce extra rules on our project or other OSS projects. Regardless, we remain on GitHub! <img src="https://raw.githubusercontent.com/ThreeMammals/Ocelot/refs/heads/assets/images/octocat.png" alt="octocat" height="20" />
<details><summary><a href="https://github.com/ThreeMammals/Ocelot/labels/DevOps">DevOps</a>: The CI/CD infrastructure was migrated from CircleCI to GitHub Actions by @raman-m</summary><br/>
Starting from version 24.0, all pull requests, development commits, and releases will be built using GitHub Actions workflows (documentation). We currently have three workflows: one for pull requests (PR), one for the develop branch (Develop), and one for the main branch (Release). All workflow runs are available on the Actions dashboard.
The PR workflow will track code coverage using Coveralls. After opening a pull request or submitting a new commit to a pull request, Coveralls will publish a short message with the current code coverage once the top commit is built. Considering that Coveralls retains the entire history but does not fail the build if coverage falls below the threshold, all workflows have a built-in 80% threshold, applied internally within the build-cake job, particularly during the "Cake Build" step-action. If the code coverage of a newly opened pull request drops below the 80% threshold, the build-cake job will fail, logging an appropriate message in the "Cake Build" step. For your information, the current code coverage of the Ocelot project is around 85-86%. The coverage threshold is subject to change in upcoming releases. All Coveralls builds can be viewed by navigating to the ThreeMammals/Ocelot project on Coveralls.io.
</details>
<details><summary><b><a href="https://github.com/ThreeMammals/Ocelot/labels/Core">Core</a></b>:</summary><br/>
The main Ocelot package and all extension packages reference net8.0 and net9.0 target framework monikers (TFMs). Refer to TargetFrameworks to verify this. The net6.0 and net7.0 TFMs have been removed. If your project still relies on these outdated TFMs, please continue using version 23.4.3.
</details>
<details><summary><b><a href="https://ocelot.readthedocs.io/en/24.0/features/authentication.html">Authentication</a></b>:</summary><br/>
Testing of Identity Server Bearer Tokens functionality was stopped due to vulnerabilities reported by Dependabot, specifically the "IdentityServer Open Redirect vulnerability" security issue. More technical details were provided in the 23.4.3 release notes, where we notified the community. Ultimately, issue #2218 was addressed via pull request #2274.
Note: In upcoming releases, we plan to utilize the ASP.NET Core Identity framework in our acceptance testing project to align with .NET industry standards. As a result, we intend to replace the IdentityServer4 library with ASP.NET Core Identity, which also supports Bearer tokens, also known as
JwtBearerHandlerfrom the Microsoft.AspNetCore.Authentication.JwtBearer namespace. </details> <details><summary><b><a href="https://ocelot.readthedocs.io/en/24.0/features/administration.html">Administration</a></b>:</summary><br/>
The Ocelot.Administration extension package has been renamed to Ocelot.Administration.IdentityServer4 (it is scheduled for deprecation) to address all IdentityServer4-related vulnerabilities (issue #2218). The package's source code has been moved out of the Ocelot repository (pull request #2274) and transferred to the newly created Ocelot.Administration.IdentityServer4 repository.
Note: Currently, the Administration feature is solely based on the IdentityServer4 package, whose repository was archived by its owner on July 31, 2024. The Ocelot team will deprecate the new Ocelot.Administration.IdentityServer4 extension package after the current Ocelot release; however, the repository will not be archived, allowing for potential patches in the future. </details> <details><summary><b><a href="https://ocelot.readthedocs.io/en/24.0/features/kubernetes.html">Kubernetes</a></b>:</summary><br/>
KubeClient, which is created from the pod account during Install-ation. As a team, we decided to add the new AddKubernetes(Action<KubeClientOptions>) method, which handles different user scenarios. It is now possible to provide manually configured KubeClientOptions in C# during Install-ation, but users can also reuse ServiceDiscoveryProvider options from the global configuration, including the Host option to construct the kubernetes endpoint address. The new overloaded AddKubernetes(Action<KubeClientOptions>) method was implemented in pull request #2257.KubeClient dependency library version was upgraded to 3.0.x, which requires .NET 8.0 and .NET 9.0 TFMs for the current Ocelot version 24.0. KubeClient v3 was internally reviewed and released specifically to meet Ocelot's needs for this release. Thanks to Adam Friedman (@tintoy) for his collaboration! This package upgrade was implemented in pull request #2266.
</details>
<details><summary><b><a href="https://github.com/ThreeMammals/Ocelot/labels/sample">Sample</a></b>:</summary><br/>The learning Samples projects were reviewed, rewritten, and refactored due to issue #1912. The community brought to our attention that the documentation and samples were outdated, as .NET 8 allows the Program.cs file to be minimized using the "Top-level statements" feature. This was ultimately addressed in pull requests #2244 and #2258.
</details>
<details><summary><b><a href="https://ocelot.readthedocs.io/en/24.0/">Documentation</a></b> Summary:</summary><br/>
:notebook: Due to the major version increase to v24, all documentation chapters were reviewed to improve readability, eliminate ambiguity, provide more useful tables and data schemas, update code snippets with the syntax of Top-level statements, and add handy samples, among other enhancements. The entire documentation is designed to be truly professional for senior developers while remaining easy to read for junior developers and newcomers who are starting to use the Ocelot gateway.
We believe that Ocelot students will ask fewer questions in 2025 :wink: For students, we always recommend finding answers in Q&A category first. Honestly, it is advised to read existing discussions before opening a new question in repo discussions. For true Ocelot patriots, we have added a README link to the smart Ocelot AI Guru assistant, which is always ready to answer any of your questions. Feel free to explore and interact with it! :blush: </details>
1<sup>st</sup> :1st_place_medal: goes to Adam Friedman for delivering 1 feature in 10 files changed 2<sup>nd</sup> :2nd_place_medal: goes to Finn Fiedler for delivering 1 feature in 3 files changed 3<sup>rd</sup> :3rd_place_medal: goes to J. Vanderlei for delivering 1 feature in 1 file changed with 49 insertions
:star::star::star: Raman Maksimchuk, @raman-m :star: Adam Friedman, @tintoy :star: Finn Fiedler, @int0x81 :star: J. Vanderlei, @jvanderlei :star: Kursat Aktas, @kursataktas
<details><summary><b>Logbook</b></summary>
net9.0 TFM | .NET 9 release | +semver: majornet9.0 TFM | .NET 9 release | +semver: breaking (#2286)AddKubernetes method with KubeClientOptions param for the discovery provider (#2257)JwtSecurityTokenHandler with JsonWebTokenHandler in the Authentication docs according to breaking changes in .NET 8 Auth (#2238)UpstreamTemplatePatternCreator (#2225)net8.0, net9.0 target frameworks (#2230)StringExtensions (#2222)
</details><details><summary><b>What's Changed</b></summary>
StringExtensions by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2222UpstreamTemplatePatternCreator by @int0x81 in https://github.com/ThreeMammals/Ocelot/pull/2225JwtSecurityTokenHandler with JsonWebTokenHandler in the Authentication docs according to breaking changes in .NET 8 Auth by @jvanderlei in https://github.com/ThreeMammals/Ocelot/pull/2238AddKubernetes method with KubeClientOptions param for the discovery provider by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2257IdentityServer4 packages and deactivate their functionality | IdentityServer Open Redirect vulnerability by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2274net9.0 TFM | .NET 9 release | +semver: breaking by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2286
</details>Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.4.3...24.0.0
Upgrading from 23.4.0-23.4.2 to 23.4.3 introduces no breaking changes. However, some internal interfaces have been updated, which should not introduce…
Milestone: Nov-December'24 Hot fixed versions: 23.4.0 — 23.4.2 Read the Docs: Ocelot 23.4 with PDF
:fire: Hot fixed bug: #2246 :heart: A sincere and heartfelt "Thank You" to Donny Tian, @donnytian for reporting the bug.
Upgrading from 23.4.0-23.4.2 to 23.4.3 introduces no breaking changes. However, some internal interfaces have been updated, which should not introduce IBC for 99.99% of projects. For further information, refer to the source code.
Regex caching by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2251Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.4.2...23.4.3
Dependabot alerts concerning reported vulnerabilities related to IdentityServer4 have not yet been addressed; these will be resolved in the next major…
[!WARNING]
Critical Hotfix for Caching users. Please upgrade to 23.4.3 ASAP❗
If your Ocelot deployment uses the Caching feature, you are affected by a critical bug — #2246 — and must upgrade to 23.4.3 immediately. Users who do not use Caching still rely on Core functionality, so they must upgrade as well, because the affected versions are 23.4.0, 23.4.1, 23.4.2.
Milestone: Nov-December'24 Hot fixed version: 23.4.1 Read the Docs: Ocelot 23.4 with PDF
This is the last patched version for .NET 6 and 7 frameworks. The upcoming major release, version 24.0, will target .NET 9 alongside the LTS .NET 8. Projects targeting .NET 6 or 7 should update to this version while considering an upgrade to .NET 8 or 9 in the future.
net6.0 and net7.0 frameworks, along with the LTS net8.0.IdentityServer4 have not yet been addressed; these will be resolved in the next major release (refer to Warnings further information).23.4.* is possible.IdentityServer4, allowing Ocelot users to utilize any authentication provider, as Ocelot's Authentication feature is provider-agnostic.IdentityServer4 library.Ocelot.Cache.CacheManager, Ocelot.Tracing.Butterfly, and Ocelot.Tracing.OpenTracing.net6.0 and net7.0 target frameworks and bump all packages by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2220Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.4.1...23.4.2
> ## Critical Hotfix for Caching users. Please upgrade to 23.4.3 ASAP❗
[!WARNING]
Critical Hotfix for Caching users. Please upgrade to 23.4.3 ASAP❗
If your Ocelot deployment uses the Caching feature, you are affected by a critical bug — #2246 — and must upgrade to 23.4.3 immediately. Users who do not use Caching still rely on Core functionality, so they must upgrade as well, because the affected versions are 23.4.0, 23.4.1, 23.4.2.
Milestone: Nov-December'24 Read the Docs: Ocelot 23.4 with PDF Hot fixed version: 23.4.0
:heart: A heartfelt "Thank You" to Guillaume Gnaegi (@ggnaegi) :fire: Hot fixed issues: #2165, #2209, #2212
SecurityOptions by @Fabman08 in https://github.com/ThreeMammals/Ocelot/pull/2170Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.4.0...23.4.1
> ## Critical Hotfix for Caching users. Please upgrade to 23.4.3 ASAP❗
[!WARNING]
Critical Hotfix for Caching users. Please upgrade to 23.4.3 ASAP❗
If your Ocelot deployment uses the Caching feature, you are affected by a critical bug — #2246 — and must upgrade to 23.4.3 immediately. Users who do not use Caching still rely on Core functionality, so they must upgrade as well, because the affected versions are 23.4.0, 23.4.1, 23.4.2.
Hotfix for Routing Placeholders users. Please upgrade to 23.4.1❗
If your Ocelot deployment uses the Routing Placeholders feature, you are affected by two bugs — #2209 and #2212 — and have to upgrade to 23.4.1 preferably. Users not using Placeholders can safely remain on 23.4.0.
Milestone: Nov-December'24 :point_left: Codenamed: McDonald's Read the Docs: Ocelot 23.4 with PDF
This minor release significantly upgrades the Routing feature by supporting embedded placeholders within path segments (between slashes). Additionally, the team has focused on enhancing the performance of Regex objects.
/{url}-2/ for /y-2/ would yield {url} = y-2. We are excited to introduce an enhanced method for evaluating placeholders that allows for the resolution of placeholders within complex URLs.
For additional information, refer to PR #2200.<details> <summary><b>Features</b>: Routing, Core, Rate Limiting, Middleware Injection</summary>
Regex logic has been refactored by @EngRajabi.
The Ocelot Core now boasts improved performance of Regex objects, striving to adhere to the Best Practices for Regular Expressions in .NET. It is estimated that each request could save from 1 to over 10 microseconds in processing time (though no benchmarks have been developed to measure this).X-Rate-Limit-* headers (found in the RateLimitingHeaders class) in the RateLimitingMiddleware's response. For more details, see PR #1307.
Note that these unofficial headers have not yet been documented, so they may be subject to change since Ocelot's RateLimiting headers do not align with industry standards.OcelotPipelineConfiguration.ClaimsToHeadersMiddleware property has been introduced by @kesskalli.
This new property enables the overriding of the ClaimsToHeadersMiddleware. For additional information, refer to PR #1403.
</details><details> <summary><b>Documentation</b> for <a href="https://ocelot.readthedocs.io/en/23.4.0/">v23.4.0</a></summary>
1<sup>st</sup> :1st_place_medal: goes to Mohsen Rajabi for delivering 1 feature in 12 files changed 2<sup>nd</sup> :2nd_place_medal: goes to Jolanta Łukawska for delivering 1 feature in 8 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Karim Esskalli for delivering 1 feature in 6 files changed
:star: Mohsen Rajabi, @EngRajabi :star: Jolanta Łukawska, @jlukawska :star: Raman Maksimchuk, @raman-m :star: Karim Esskalli, @kesskalli :star: Guillaume Gnaegi, @ggnaegi
<details><summary><b>Logbook</b></summary>
Regex performance review (#1348)HttpContext response accessed via IHttpContextAccessor (#1307)ClaimsToHeadersMiddleware by the OcelotPipelineConfiguration settings (#1403)</details> <details><summary><b>What's Changed</b></summary>
ClaimsToHeadersMiddleware by the OcelotPipelineConfiguration settings by @kesskalli in https://github.com/ThreeMammals/Ocelot/pull/1403HttpContext response accessed via IHttpContextAccessor by @jlukawska in https://github.com/ThreeMammals/Ocelot/pull/1307Regex performance review by @EngRajabi in https://github.com/ThreeMammals/Ocelot/pull/1348</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.3.6...23.4.0
Bump everything | Hot fixing Microsoft.Extensions.Caching.Memory | Microsoft Security Advisory CVE-2024-43483 by @dependabot in https://github.com/Thr…
Milestone: October'24 👈 Read the Docs: Ocelot 23.3 with PDF Hot fixed version: 23.3.4
:heart: A heartfelt "Thank You" to Nikolai Masson (@Niksson) and Nikolay Kuksov (@kick2nick) for their contributions!
This release provides minor bug fixes from the previous 23.3.4 release. All bugs have been addressed in the October'24 milestone.
:notebook: For projects utilizing the Service Discovery feature, it is recommended to update to this version to benefit from the unstable release 23.3.4, which includes fixes for both Consul and Kube discovery providers.
The Ocelot solution encountered a significant issue with the disabled scope validation of services in the DI-container, affecting both testing projects and the core library. Initially, this was not problematic when services were designed as singletons by previous contributors and our team. However, with the introduction of more scoped services by the Ocelot team, it became clear that our testing projects could not adequately handle them. This patch introduces scope validation across all domains: unit tests, acceptance tests, and the core library itself. We advise always enabling scope validation in your custom Ocelot solutions, especially when dealing with numerous C# overridden classes in the DI-container and any attached custom functionality.
The patch enhances functionality for two primary Service Discovery providers:
System.InvalidOperationException error stating "Cannot resolve scoped service 'Ocelot.Provider.Consul.Interfaces.IConsulServiceBuilder' from root provider" has been resolved.
To clarify, the IConsulServiceBuilder service is a scoped service in DI, injected via the AddConsul() or AddConsul<T>() methods. Therefore, the DefaultConsulServiceBuilder should also be a scoped service, with HttpContext injected to meet your development requirements.System.InvalidOperationException with the message: "Cannot resolve scoped service 'KubeClient.IKubeApiClient' from root provider." This "invalid scopes" error occurred only in development mode, as release mode DLLs do not validate scopes. However, the KubeApiClient is designed to have a scoped lifetime. Acceptance tests passed because scope validation was disabled, and the KubeClient was replaced with a singleton. This inconsistency was identified and reproduced by the old 977 issue. As a temporary solution, the IKubeApiClient was registered as a singleton.
Looking ahead, our team intends to redesign the Kubernetes provider to have a default service builder that is scoped, similar to the Consul provider.Upgrading from 23.3.4 to 23.3.6 introduces no breaking changes. However, upgrading from 23.3.0 or earlier versions may result in some incompatibilities. For further information, please refer to the release notes of v23.3.4.
:star::star: Raman Maksimchuk, @raman-m :star: Henrique Holtz, @henriqueholtz :star: Nikolay, @kick2nick :star: Nikolai Masson, @Niksson :star: Emmanuel Ferdman, @emmanuel-ferdman :star: dependabot[bot], @dependabot
async vs await improvements by @henriqueholtz in https://github.com/ThreeMammals/Ocelot/pull/2156HttpContext request services for the IConsulServiceBuilder service by @Niksson in https://github.com/ThreeMammals/Ocelot/pull/2179Kube and PollKube discovery providers by @kick2nick in https://github.com/ThreeMammals/Ocelot/pull/2180servicediscovery.rst by @emmanuel-ferdman in https://github.com/ThreeMammals/Ocelot/pull/2187Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.3.5...23.3.6
Our team has implemented some Breaking Changes which we urge you to review carefully (details follow).
Milestone: v23.3 Hotfixes 👈 Codenamed: Blue Olympic Fiend Read the Docs: Ocelot 23.3 Hot fixed versions: 23.3.0, 23.3.3
❤️ A heartfelt "Thank You" to Roman Shevchik and Massimiliano Innocenti for their contributions in testing and reporting the Service Discovery issues, #2110 and #2119, respectively!
This release delivers a number of bug fixes for the predecessor's 23.3.0 release, which is full of new features but was not tested well. All bugs were combined into the v23.3 Hotfixes milestone.
Following the substantial refactoring of Service Discovery providers in the 23.3.0 release, the community identified and we have acknowledged several critical service discovery defects with providers such as Kube and Consul. The Kube provider, while somewhat unstable, remained operational; however, the Consul provider was entirely non-functional.
📓 If your projects rely on the Service Discovery feature and cannot function without it, please upgrade to this version to utilize the full list of features of version 23.3.0.
A comprehensive explanation of the technical details would span several pages; therefore, it is advisable for fans of Ocelot to review all pertinent technical information within the issue descriptions associated with the milestone. Our team has implemented some Breaking Changes which we urge you to review carefully (details follow).
Listed by priority:
ILoadBalancer interface alteration: Method Lease is now LeaseAsync.
Interface FQN: Ocelot.LoadBalancer.LoadBalancers.ILoadBalancer
Method FQN: Ocelot.LoadBalancer.LoadBalancers.ILoadBalancer.LeaseAsyncDefaultConsulServiceBuilder constructor modification: The first parameter's type has been changed from Func<ConsulRegistryConfiguration> to IHttpContextAccessor.
Class FQN: Ocelot.Provider.Consul.DefaultConsulServiceBuilder
Constructor signature: public DefaultConsulServiceBuilder(IHttpContextAccessor contextAccessor, IConsulClientFactory clientFactory, IOcelotLoggerFactory loggerFactory)Lease type: The Lease has been restructured from a class to a structure and elevated in the namespace hierarchy.
Struct FQN: Ocelot.LoadBalancer.Lease📓 Should your custom solutions involve overriding default Ocelot classes and their behavior, redevelopment or at least recompilation of the solution, followed by deployment, will be necessary.
1<sup>st</sup> :1st_place_medal: goes to Roman Shevchik for delivering 1 feature in 25 files changed 2<sup>nd</sup> :2nd_place_medal: goes to Ben Bartholomew for delivering 1 feature in 7 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Paul Roy for delivering 1 feature in 5 files changed
:star::star: Raman Maksimchuk, @raman-m :star: Roman Shevchik, @antikorol :star: Ben Bartholomew, @ben-bartholomew :star: Paul Roy, @PaulARoy :star: Finn Fiedler, @int0x81 :star: Emmanuel Ferdman, @emmanuel-ferdman :star: dependabot[bot], @dependabot
<details><summary><b>Logbook</b></summary>
DefaultConsulServiceBuilder with ConsulProviderFactory refactoring to make it thread safe and friendly (#2151)Regex constructor derived from URL query parameter values containing special Regex chars (#2150)README.md (#2149)Content-Length header in MultiplexingMiddleware (#2146)Kube provider (#2111)GetMergedOcelotJson when providing the folder argument of AddOcelot (#2120)</details> <details><summary><b>What's Changed</b></summary>
GetMergedOcelotJson when providing the folder argument of AddOcelot by @ben-bartholomew in https://github.com/ThreeMammals/Ocelot/pull/2120Kube provider by @antikorol in https://github.com/ThreeMammals/Ocelot/pull/2111Content-Length header in MultiplexingMiddleware by @PaulARoy in https://github.com/ThreeMammals/Ocelot/pull/2146README.md by @emmanuel-ferdman in https://github.com/ThreeMammals/Ocelot/pull/2149Regex constructor derived from URL query parameter values containing special Regex chars by @int0x81 in https://github.com/ThreeMammals/Ocelot/pull/2150DefaultConsulServiceBuilder with ConsulProviderFactory refactoring to make it thread safe and friendly by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2151</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.3.3...23.3.4
Nothing published for this version
> Milestone: [Spring'24](https://github.com/ThreeMammals/Ocelot/milestone/6) :point_left:
Milestone: Spring'24 :point_left: Codenamed: Twilight Texas Read the Docs: Ocelot 23.3 with PDF
Following the substantial refactoring of Service Discovery providers in this release, the community has identified and we have acknowledged several critical service discovery defects with providers such as Consul, Kube, and potentially others. <ins>The Kube provider, while somewhat unstable, remains operational; however, the Consul provider is entirely non-functional.</ins> We apologize to the projects and clients affected by these issues.
If your projects rely on the Service Discovery feature and cannot function without it, please refrain from upgrading to version 23.3.0; instead, continue using or revert to the previous version 23.2.2. However, if your team does not utilize the Service Discovery feature, then upgrading to this version should be fine. The Ocelot team is currently working on the v23.3 Hotfixes milestone during the summer of 2024, and we are optimistic that <ins>the hotfixed version 23.3.4 is expected to be available at the beginning of September 2024.</ins> We appreciate your understanding and support.
POST, PUT requests), then enable content hashing in global caching settings: utilize the "EnableContentHashing option"❗<details> <summary><b>Service Discovery</b>: Major upgrade of <i>Kube</i> and <i>Consul</i> providers: new <i>"Customization of services creation"</i> feature</summary>
Introducing a new feature for "Customization of services creation" in two primary service discovery providers: Consul and Kubernetes, developed by @raman-m.
The customization for both Consul and Kube providers in service creation is achieved through the overriding of virtual methods in default implementations (the DefaultConsulServiceBuilder and KubeServiceBuilder classes). The recommendation was to separate the provider's logic and introduce public virtual and protected virtual methods in concrete classes, enabling:
public virtual methods as dictated by interface definitions.protected virtual methods to allow developers to customize atomic operations through inheritance from existing concrete classes.Ultimately, customization relies on the virtual methods within the default implementation classes, providing developers the flexibility to override them as necessary for highly tailored Consul/K8s configurations in their specific environments.
For further details, refer to the respective pull requests for both providers: Kube #2052, Consul #2067
</details>
<details>
<summary><b>Routing</b>: New <i>"Routing based on Request Header"</i> feature</summary>
Introducing the new "Routing based on Request Header" feature by @jlukawska.
In addition to routing via UpstreamPathTemplate, you can now define an UpstreamHeaderTemplates options dictionary. For a route to match, all headers specified in this section are required to be present in the request headers.
For more details, see PR #1312.
</details>
<details>
<summary><b>Configuration</b>: New <i>"Custom Default Version Policy"</i> and <i>"Route Metadata"</i> features</summary>
Introducing the "Custom Default Version Policy" feature by @ibnuda.
The configurable HttpRequestMessage.VersionPolicy helps avoid HTTP protocol connection errors and stabilizes connections to downstream services, especially when you're not developing those services, documentation is scarce, or the deployed HTTP protocol version is uncertain.
For developers of downstream services, it's possible to ConfigureKestrel server and its endpoints with new protocol settings. However, attention to version policy is also required, and this feature provides precise version settings for HTTP connections.
Essentially, this feature promotes the use of HTTP protocols beyond 1.0/1.1, such as HTTP/2 or even HTTP/3.
For additional details, refer to PR #1673.
Introducing the new "Route Metadata" feature by @vantm. Undoubtedly, this is the standout feature of the release! :star:
Route metadata enables Ocelot developers to incorporate custom functions that address specific needs or to create their own plugins/extensions.
In versions of Ocelot prior to 23.3.0, the configuration was limited to predefined values that Ocelot used internally. This was sufficient for official extensions, but posed challenges for third-party developers who needed to implement configurations not included in the standard FileConfiguration. Applying an option to a specific route required knowledge of the array index and other details that might not be readily accessible using the standard IConfiguration or IOptions<FileConfiguration> models from ASP.NET. Now, metadata can be directly accessed in the DownstreamRoute object. Furthermore, metadata can also be retrieved from the global JSON section via the FileConfiguration.GlobalConfiguration property.
For more information, see the details in PR #1843 on this remarkable feature.
</details>
<details> <summary><b>Updates of the features</b>: Configuration, Service Discovery, Routing and Quality of Service</summary>
Configuration: New features are "Custom Default Version Policy" by @ibnuda and "Route Metadata" by @vantm.
Service Discovery: New feature is "Customization of services creation" by @raman-m.
Routing: New feature is "Routing based on Request Header" by @jlukawska.
Quality of Service: The team has decided to remove the Polly V7 policies logic and the corresponding Ocelot AddPollyV7 extensions (referenced in PR #2079). Furthermore, the Polly V8 Circuit Breaker has been mandated as the primary strategy (as per PR #2086).
See more detailed below in "Ocelot extra packages" paragraph.
</details>
<details> <summary><b>Ocelot extra packages</b></summary>
Our team has resolved to eliminate the Polly V7 policies logic and the corresponding Ocelot AddPollyV7 extensions entirely (refer to the "Polly v7 vs v8" documentation). In the previous 23.2 release, named Lunar Eclipse, we included these to maintain the legacy Polly behavior, allowing development teams to transition or retain the old Polly V7 functionality. We are now confident that it is time to progress alongside Polly, shifting our focus to the new Polly V8 resilience pipelines. For more details, see PR #2079.
Additionally, we have implemented Polly v8 Circuit Breaker as the primary strategy. Our Quality of Service () relies on two main strategies: Circuit Breaker and Timeout. If both Circuit Breaker and Timeout are configured with their respective properties in the QoSOptions of the route JSON, then the Circuit Breaker strategy will take precedence in the constructed resilience pipeline. For more details, refer to PR #2086.
</details>
<details> <summary><b>Stabilization</b> (bug fixing)</summary>
See all bugs of the Spring'24 milestone </details>
<details> <summary><b>Documentation</b> for version <a href="https://ocelot.readthedocs.io/en/23.3.0/">23.3.0</a></summary>
1<sup>st</sup> :1st_place_medal: goes to Raynald Messié for delivering 2 features 2<sup>nd</sup> :2nd_place_medal: goes to Ibnu Daru Aji for delivering 1 feature in 42 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Jolanta Łukawska for delivering 1 feature in 39 files changed 4<sup>th</sup> :orange_heart: goes to Van Tran for delivering 1 feature in 31 files changed 5<sup>th</sup> :yellow_heart: goes to Sergii Strikhar for delivering 1 feature in 29 files changed
:star::star::star::star::star: Raman Maksimchuk, @raman-m :star::star: Raynald Messié, @RaynaldM :star: Ibnu Daru Aji, @ibnuda :star: Jolanta Łukawska, @jlukawska :star: Van Tran, @vantm :star: Sergii Strikhar, @sergio-str :star: Thiago Loureiro, @thiagoloureiro :star: Paul Roy, @PaulARoy :star: Zhannur Akhmetkhanov, @hogwartsdeveloper :star: Béchir Ben Ameur, @bbenameur
<details><summary><b>Logbook</b></summary>
DownstreamUrlCreatorMiddleware (#2003)Consul service discovery provider (#2067)EnableContentHashing setting by global CacheOptions (#2058)Kube service discovery provider (#2052)configuration.rst (#2048)</details> <details><summary><b>What's Changed</b></summary>
configuration.rst by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2048Kube service discovery provider by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2052EnableContentHashing setting by global CacheOptions by @thiagoloureiro in https://github.com/ThreeMammals/Ocelot/pull/2058Consul service discovery provider by @raman-m in https://github.com/ThreeMammals/Ocelot/pull/2067DownstreamUrlCreatorMiddleware by @bbenameur in https://github.com/ThreeMammals/Ocelot/pull/2003</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.2.2...23.3.0
:heart: Special thanks to [Guillaume Gnaegi](https://github.com/ggnaegi) and Fabrizio Mancin!
Hot fixed version: 23.2.0
:heart: Special thanks to Guillaume Gnaegi and Fabrizio Mancin!
The bug is related to the Placeholders feature in Configuration and Routing. The bug was introduced in version 23.2.0 as part of PR #1927.
The new validation rules of the FileConfigurationFluentValidator class do not allow the Ocelot app to start when implicit placeholders are defined in custom implementations, such as middlewares, delegating handlers, and replaced services in the dependency injection (DI) container.
These new rules are capable of validating explicit placeholders only within the UpstreamPathTemplate and DownstreamPathTemplate properties. Unfortunately, they cannot oversee implicit placeholders in custom implementations, and they do not validate early during the Ocelot app startup process.
Ensure that you avoid using version 23.2.0. If you are currently on that version, upgrade to version 23.2.2 by applying this hotfix patch.
With version 23.2.0, particularly if you have overridden certain service classes or implemented custom logic that manipulates placeholders, you may encounter Ocelot app crashes accompanied by the following errors in the log:
One or more errors occurred. (Unable to start Ocelot, errors are: XXX)
where XXX are the following validation error messages:
UpstreamPathTemplate 'UUU' doesn't contain the same placeholders in DownstreamPathTemplate 'DDD'DownstreamPathTemplate 'DDD' doesn't contain the same placeholders in UpstreamPathTemplate 'UUU'Finally, the validation rules resulted from the incorrect assumption that placeholders are always explicit and can be validated early. Therefore, custom implementations and feature services in the dependency injection (DI) container, which rely on or manipulate placeholders, should validate the configuration JSON and appropriate options later, directly within their service implementations.
<details><summary><b>Logbook</b></summary>
<sub>2ded8726 by Raman Maksimchuk on Friday, April 05 at 15:13 →</sub> Release 23.2.1-2 artifacts | +semver: patch <sub>14c6d82b by Raman Maksimchuk on Friday, April 05 at 12:57 →</sub> #2031 Don't validate placeholders in templates (#2032) <sub>d1855cb9 by Raman Maksimchuk on Thursday, April 04 at 00:17 →</sub> #1673 #1672 Update Docker for CircleCI builds (#2030)
</details> <details><summary><b>What's Changed</b></summary>
</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.2.1...23.2.2
> Milestone: [February'24](https://github.com/ThreeMammals/Ocelot/milestone/5) :point_left:
Milestone: February'24 :point_left: Codenamed: Lunar Eclipse Read the Docs: Ocelot 23.2 with PDF
AddOcelot method merges the ocelot.*.json files into a single ocelot.json file as the primary configuration file, which is written back to disk and then added to the IConfigurationBuilder for the well-known IConfiguration. You can now call another AddOcelot method that adds the merged JSON directly from memory to the IConfigurationBuilder, using AddJsonStream instead.
See more details in Configuration Overview of Dependency Injection.<details> <summary><b>Updates of the features</b>: Configuration, Dependency Injection and QoS</summary>
<details> <summary><b>Ocelot extra packages</b></summary>
[Obsolete] attribute and renamed using the V7 suffix. And the old v7 implementation has been moved to the v7 namespace.
See more details in Polly v7 vs v8 section of Quality of Service chapter.
</details><details> <summary><b>Stabilization</b> aka bug fixing</summary>
IServiceCollection DI extensions to register Ocelot services resulted in the ServiceCollection provider being forced to be created by calling BuildServiceProvider().
This resulted in problems with dependency injection libraries, or worse, causing the Ocelot app to crash!
See more in the ServiceCollectionExtensions class. Thanks to @ArwynFr!<details> <summary><b>Documentation</b> for version <a href="https://ocelot.readthedocs.io/en/23.2.2/">23.2</a></summary>
1<sup>st</sup> :1st_place_medal: goes to Eirik Bjornset for delivering 1 feature in 19 files changed 2<sup>nd</sup> :2nd_place_medal: goes to Aly Kafoury for delivering 1 feature in 9 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Adrien Hupond for delivering 1 feature in 6 files changed
:star: Eirik Bjornset, @ebjornset :star: Aly Kafoury, @AlyHKafoury :star: Adrien Hupond, @ArwynFr :star: Raman Maksimchuk, @raman-m :star: Raynald Messié, @RaynaldM
<details><summary><b>Logbook</b></summary>
IServiceCollection (#1986)AddOcelot method to support merging of configuration files to memory (#1227)</details> <details><summary><b>What's Changed</b></summary>
AddOcelot method to support merging of configuration files to memory by @ebjornset in https://github.com/ThreeMammals/Ocelot/pull/1227IServiceCollection by @ArwynFr in https://github.com/ThreeMammals/Ocelot/pull/1986</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.1.0...23.2.0
> Milestone: [January'24](https://github.com/ThreeMammals/Ocelot/milestone/4) :point_left:
Milestone: January'24 :point_left: Codenamed: Hornussen Sport Read the Docs: Ocelot 23.1 with PDF
<details> <summary><b>Multiplexing middleware</b> aka <a href="https://ocelot.readthedocs.io/en/latest/features/requestaggregation.html">Request Aggregation</a> feature</summary>
HttpContext is not copied when there is only one downstream route, and etc.HttpContext.User information was not copied if there was more than one downstream request.
</details><details> <summary><b>System routing</b>. Content streaming when <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Transfer-Encoding">Transfer-Encoding</a>: 'chunked'</summary>
chunked was present even when there was no content or the request body size was 0. These cases are now addressed.
</details><details> <summary><b>Updates of the features</b>: QoS, Load Balancer and Error Status Codes</summary>
AddPolly extension methods.PayloadTooLargeError (Ocelot error code 41).
</details><details> <summary>Documentation for <b>Request Aggregation</b></summary>
<details> <summary><b>Stabilization</b> aka bug fixing</summary>
1<sup>st</sup> :1st_place_medal: goes to Guillaume Gnaegi for delivering 2 features 2<sup>nd</sup> :2nd_place_medal: goes to Alexander Reinert for delivering 1 feature in 8 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Steven Liekens for delivering 1 feature in 5 files changed with 353 insertions
:star::star: Guillaume Gnaegi, @ggnaegi :star: Alexander Reinert, @alexreinert :star: Steven Liekens, @sliekens :star: Ugway77, @Ugway77 :star: Raman Maksimchuk, @raman-m :star: Masoud Bahrami, @masoud-bahrami :star: Chris Williams, @williamscs :star: Raynald Messié, @RaynaldM
<details><summary><b>Logbook</b></summary>
IOException while reading incoming request body (#1769)HttpRequesterMiddleware (#1953)User in MultiplexingMiddleware (#1462)DistributedCacheRateLimitCounterHandler class (#1969)
</details><details><summary><b>What's Changed</b></summary>
DistributedCacheRateLimitCounterHandler class by @williamscs in https://github.com/ThreeMammals/Ocelot/pull/1969User in MultiplexingMiddleware by @Ugway77 in https://github.com/ThreeMammals/Ocelot/pull/1462HttpRequesterMiddleware by @masoud-bahrami in https://github.com/ThreeMammals/Ocelot/pull/1953IOException while reading incoming request body by @ggnaegi in https://github.com/ThreeMammals/Ocelot/pull/1769</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/23.0.0...23.1.0
Ocelot.Provider.Kubernetes: Fixed long lasting breaking change being added in version 15.0.0, see commit https://github.com/ThreeMammals/Ocelot/commit…
Milestone: Nov-December'23 :point_left: Codenamed: Sunny Koliada Read the Docs: Ocelot 23.0 with PDF
<details> <summary><b>System performance</b>. System core performance review, redesign of system core related to routing and content streaming</summary>
Modification of the RequestMapper with a brand new StreamHttpContent class, in Ocelot.Request.Mapper namespace. The request body is no longer copied when it is handled by the API gateway, avoiding Out-of-Memory issues in pods/containers. This significantly reduces the gateway's memory consumption, and allows you to transfer content larger than 2 GB in streaming scenarios.
Introduction of a new Message Invoker pool, in Ocelot.Requester namespace. We have replaced the HttpClient class with HttpMessageInvoker, which is the base class for HttpClient. The overall logic for managing the pool has been simplified, resulting in a reduction in the number of CPU cycles.
Full HTTP content buffering is deactivated, resulting in a 50% reduction in memory consumption and a performance improvement of around 10%. Content is no longer copied on the API gateway, avoiding Out-of-Memory issues.
Memory consumption summary. We would like to share here some screenshots of K8s pods from our production environment. These charts were created on January 29-30. Special thanks to @RaynaldM for providing the screenshots! (Click on the image to see the full resolution picture) 👇
| 3 hours chart | 1 day chart | 2 days chart |
|---|---|---|
| ~300 MB on average | ~320 MB on average | ~340 MB on average |
Finally, we confirm that memory consumption is stable, and <ins>Ocelot ver. 23.0 is ready for use in production environments</ins>—even as a containerized application that may lack the memory resources of a Docker container. The typical memory consumption of a minimal ASP.NET Web API application at startup is around 250 MB. However, this figure depends on several indicators, including content body size, application load (i.e., requests per second index), and integration within the application core. For high-load systems, a deployed Ocelot Docker container can allocate up to 400-500 MB, but we hope it won’t exceed that range. In our production environment, a container instance typically occupies around 350 MB. We recommend monitoring the deployed containers in your production environment, paying attention to their CPU & memory consumption. We believe that there will be no out-of-memory incidents at all. </details>
<details> <summary><b>Ocelot extra packages</b>. Total 3 Ocelot packs were updated</summary>
Ocelot.Cache.CacheManager: Introduced default cache key generator with improved performance (the DefaultCacheKeyGenerator class). Old version of CacheKeyGenerator had significant performance issue when reading full content of HTTP request for caching key calculation of MD5 hash value. This hash value was excluded from the caching key.
Ocelot.Provider.Kubernetes: Fixed long lasting breaking change being added in version 15.0.0, see commit https://github.com/ThreeMammals/Ocelot/commit/6e5471a714dddb0a3a40fbb97eac2810cee1c78d. The bug persisted for more than 3 years in versions 15.0.0-22.0.1, being masked multiple times via class renaming! Special Thanks to @ZisisTsatsas who once again brought this issue to our attention, and our team finally realized that we had a breaking change and the provider was broken.
Ocelot.Provider.Polly: A minor changes without feature delivery. We are preparing for a major update to the package in the next release. </details>
<details> <summary><b>Middlewares</b>. Total 8 Ocelot middlewares were updated</summary>
AuthenticationMiddleware: Added new Multiple Authentication Schemes feature by @MayorSheFFOutputCacheMiddleware, RequestIdMiddleware: Added new Cache by Header Value feature by @EngRajabi, and redesigned as Default CacheKeyGenerator feature by @raman-mDownstreamUrlCreatorMiddleware: Fixed bug for ending/omitting slash in path templates aka Empty placeholders feature by @AlyHKafouryConfigurationMiddleware, HttpRequesterMiddleware, ResponderMiddleware: System upgrade for Custom HttpMessageInvoker pooling feature by @ggnaegiDownstreamRequestInitialiserMiddleware: System upgrade for Performance of Request Mapper feature by @ggnaegi
</details><details> <summary>Documentation for <b>Authentication</b>, <b>Caching</b>, <b>Kubernetes</b> and <b>Routing</b></summary>
<details> <summary><b>Stabilization</b> aka bug fixing</summary>
<details> <summary><b>Testing</b></summary>
Ocelot.Benchmarks testing project has been updated with new PayloadBenchmarks and ResponseBenchmarks by @ggnaegiOcelot.AcceptanceTests testing project has been refactored by @raman-m using the new AuthenticationSteps class, and more refactoring will be done in future releases
</details>1<sup>st</sup> :1st_place_medal: goes to Guillaume Gnaegi for delivering 3 features 2<sup>nd</sup> :2nd_place_medal: goes to Igor Polishchuk for delivering 1 feature in 25 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Aly Kafoury for delivering 1 feature in 9 files changed
:star::star::star: Guillaume Gnaegi, @ggnaegi :star::star: Raman Maksimchuk, @raman-m :star: Igor Polishchuk, @MayorSheFF :star: Aly Kafoury, @AlyHKafoury :star: Zisis Tsatsas, @ZisisTsatsas :star: Tanmay Seth, @ks1990cn :star: Mohsen Rajabi, @EngRajabi
<details><summary><b>Logbook</b></summary>
Kube service discovery provider (#1954)HttpMessageInvoker pooling (#1824)HttpMessageInvoker pooling by @ggnaegi in https://github.com/ThreeMammals/Ocelot/pull/1824Kube service discovery provider by @ZisisTsatsas in https://github.com/ThreeMammals/Ocelot/pull/1954Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/22.0.1...23.0.0
We would like to share our team's plans for the future regarding: development trends, ideas, community expectations, etc.
<details> <summary><b>Code Review and Performance Improvements</b></summary>
Without a doubt, we care about code quality every day, following best development practices. And we review, test, refactor, and redesign features with overall performance in mind. In the next few releases (versions 23.x-24.0) we will take care of: generic providers, multiplexing middleware (Aggregation feature), memory management. </details> <details> <summary><b>Server-Sent Events protocol support</b></summary>
There is a lot of community interest in this HTTP-based protocol. </details> <details> <summary><b>Long Polling for Consul provider</b></summary>
Consul is our leading technology for service discovery. We are constantly improving the use cases for the Ocelot.Provider.Consul package and trying to improve the code inside the package.
</details>
<details>
<summary><b>QoS feature refactoring</b></summary>
Polly was released with the new v.8.2+ after .NET 8. So we have to update Ocelot.Provider.Polly package taking into account new Polly behavior of redesigned features.
</details>
<details>
<summary><b>Brainstorming</b></summary>
Brainstorming to redesign Rate Limiting, Websockets. More details in future release notes. </details> <details> <summary><b>Planning</b></summary>
Planning of support for Swagger and gRPC proto. More details in future release notes. </details>
> Default timeout vs the Quality of Service feature
Default timeout vs the Quality of Service feature Hot fixed version: 22.0.0
Special thanks to Alvin Huang!
The bug is related to the Quality of Service feature (aka QoS) and the HttpClient.Timeout property.
QoSOptions section is defined in the route config, then the bug is masked rather than active, and the timeout value is assigned from the QoS TimeoutValue property.QoSOptions section is not defined in the route config or the TimeoutValue property is missing, then the bug is active and affects downstream requests that never time out.FileQoSOptions class. Make sure your custom code proper usage of the Ocelot.Configuration.DownstreamRoute class QosOptions.TimeoutValue property!In version 22.0, the bug was found in the explicit default constructor of the FileQoSOptions class with a maximum TimeoutValue. Previously, the default constructor was implicit with the default assignment of zero 0 to all int properties.
The new explicit default constructor breaks the old implementation of QoS TimeoutValue logic, as our QoS documentation states:
<br/>
Finally, the "default 90 second" logic for HttpClient breaks down when there are no QoS options and all requests on those routes are infinite, if, for example, downstream services are down or stuck.
:star: Alvin Huang, @huanguolin :star: Raman Maksimchuk, @raman-m
<details><summary><b>Logbook</b></summary>
</details> <details><summary><b>What's Changed</b></summary>
</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/22.0.0...22.0.1
> Milestone: [October'23](https://github.com/ThreeMammals/Ocelot/milestone/1) :point_left:
Milestone: October'23 :point_left: Codenamed: Swiss Locomotive Read the Docs: Ocelot 22.0 with PDF
<details> <summary><b>Logging feature</b>. Performance review, redesign and improvements with new best practices to log</summary>
Proposing a centralized WriteLog method for the OcelotLogger
Factory methods for computed strings such as string.Format or interpolated strings
Using ILogger.IsEnabled before calling the native WriteLog implementation and invoking string factory method
</details>
<details>
<summary><b>Quality of Service feature</b>. Redesign and stabilization, and it produces less log records now.</summary>
Fixing issue with Polly Circuit Breaker not opening after max number of retries reached
Removing useless log calls that could have an impact on performance
Polly lib reference updating to latest 8.2.0 with some code improvements
</details>
<details>
<summary>Documentation for <b>Logging</b>, <b>Request ID</b>, <b>Routing</b> and <b>Websockets</b></summary>
Websockets </details> <details> <summary>Testing improvements and stabilization aka <b>bug fixing</b></summary>
Routing bug fixing: query string placeholders including CatchAll one aka {everything} and query string duplicates removal
QoS bug fixing: Polly circuit breaker exceptions
Testing bug fixing: rare failed builds because of unstable Polly tests. Acceptance common logic for ports </details>
1<sup>st</sup> :1st_place_medal: goes to Guillaume Gnaegi for delivering 2 features in 99 files changed 2<sup>nd</sup> :2nd_place_medal: goes to Raynald Messié for delivering 2 features in 15 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Jolanta Łukawska for delivering 1 feature in 51 files changed
:star::star::star: Raman Maksimchuk, @raman-m :star::star: Guillaume Gnaegi, @ggnaegi :star::star: Raynald Messié, @RaynaldM :star: Jolanta Łukawska, @jlukawska :star: Samuel Poirier, @samuel-poirier :star: Stjepan Majdak, @wast
<details><summary><b>Logbook</b></summary>
</details> <details><summary><b>What's Changed</b></summary>
</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/21.0.0...22.0.0
> Read the Docs: Ocelot 21.0 with PDF
net8.0, version 21.0) a.k.a. the .NET 8 releaseCodenamed: .NET 8 Read the Docs: Ocelot 21.0 with PDF Target Framework Monikers:
net6.0,net7.0,net8.0
On November 14th, 2023, the .NET team announced the release of the .NET 8 framework:
We are pleased to announce to you that we can now offer the support of .NET 8. But that is not all, in this release, we are adopting support of several versions of the .NET framework through multitargeting. The Ocelot distribution is now compatible with .NET 6, 7 and 8. :tada:
In the future, we will try to ensure the support of the .NET SDKs that are still actively maintained by the .NET team and community. Current .NET versions in support are the following: 6, 7, 8.
As an ASP.NET Core app, now Ocelot targets net6.0, net7.0 and net8.0 frameworks. Starting with v21.0.0, the solution's code base supports Multitargeting as SDK-style projects. Find out more here: Target frameworks in SDK-style projects.
It should be easier for teams to move between (migrate to) .NET 6, 7 and 8 frameworks. Also, new features will be available for all .NET SDKs which we support via multitargeting.
1<sup>st</sup> :1st_place_medal: goes to Guillaume Gnaegi for delivering 1 feature in 63 files changed 2<sup>nd</sup> :2nd_place_medal: goes to Raman Maksimchuk for delivering 1 feature in 17 files changed 3<sup>rd</sup> :3rd_place_medal: goes to @raman-m for delivering 1 feature in 5 files changed
:star: Guillaume Gnaegi, @ggnaegi :star: Raman Maksimchuk, @raman-m
<details><summary><b>Logbook</b></summary>
</details> <details><summary><b>What's Changed</b></summary>
</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/20.0.1...21.0.0
> Read the Docs: Ocelot 20.0 with PDF
Codenamed: Polish Apple Read the Docs: Ocelot 20.0 with PDF
1<sup>st</sup> :1st_place_medal: goes to Raman Maksimchuk for delivering 5 features 2<sup>nd</sup> :2nd_place_medal: goes to @jlukawska for delivering 3 features 3<sup>rd</sup> :3rd_place_medal: goes to Guillaume Gnaegi for delivering 2 features
:star::star::star::star::star: Raman Maksimchuk, @raman-m :star::star::star: @jlukawska :star::star: Guillaume Gnaegi, @ggnaegi :star: Anthony Steele, @AnthonySteele :star: Ben Bartholomew, @ben-bartholomew :star: @DanHarltey :star: Fabrizio Mancin, @Fabman08 :star: Freddy, @fku- :star: Kevin Grossmann, @grssmnn :star: Marco, @eddex :star: Roman, @ArtRoman :star: Thiago Loureiro, @thiagoloureiro :star: Vijay Karavadra, @vijay-karavadra :star: guoyongchang, @guoyongchang :star: leonluc-dev, @leonluc-dev :star: zhangq, @zqlovejyc
<details><summary><b>Logbook</b></summary>
</details> <details><summary><b>What's Changed</b></summary>
</details>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/19.0.3...20.0.0
Nothing published for this version
Read the Docs: Ocelot 19.0 with PDF
Read the Docs: Ocelot 19.0 with PDF
ebe70fd7 - Raman Maksimchuk - Merge pull request #1695 from ThreeMammals/develop a90664b4 - Raman Maksimchuk - Release features #1499 #1663 (#1660) (#1693) 346df03d - Tom Pallister - Update README.md 433dfcaf - Justin Middler - fixed up required spacing in README (#1499) 6ca54fe0 - Raman Maksimchuk - #1660 Huge logs because of StyleCop.Analyzers warnings (#1663) bc25f4e8 - TomPallister - push code coverage for main and develop branches
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/19.0.2...19.0.3
Read the Docs: Ocelot 19.0 with PDF
Read the Docs: Ocelot 19.0 with PDF
fdc761c3 - TomPallister - updated docs 3bd0f8d5 - Tom Pallister - updated report generator (#1648) https://github.com/ThreeMammals/Ocelot/commit/b9cc313c31828fd90a4ec2af21958577c5277fc9 - Tom Pallister - updated nuget package icon url
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/19.0.0...19.0.2
Nothing published for this version
Read the Docs: Ocelot 19.0 with PDF
Read the Docs: Ocelot 19.0 with PDF
46b12a2f - TomPallister - updated cake syntax 4db816af - TomPallister - updated Cake.Coveralls dec610d1 - TomPallister - updated csmacnz.Coveralls 66d09e3d - TomPallister - updated csmacnz.Coveralls b2ec1650 - TomPallister - updated eddiewebb/queue@2.2.1 312f1c6b - Tom Pallister - tests passing on debian 10 (#1647) 07263be5 - TomPallister - Merge branch 'RaynaldM-upgrade-to-net7' into develop 89208364 - TomPallister - +semver: major updated build c444c254 - Ray - last packages update 4afdea35 - Ray - code cleaning 96a3fd82 - Ray - First step
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/18.0.0...19.0.0
Read the Docs: Ocelot 18.0 with PDF
Read the Docs: Ocelot 18.0 with PDF
36ad6e1e - TGP - use the DotNetNuGet cake code b6b789c3 - TGP - add nuget to cake as a tool 565968a8 - TGP - use xplat nuget package for cake 822a0b0d - TGP - add nuget tool for publish to cake script f1db0257 - TGP - install net5.0 in correct place in container c07e6ee4 - TGP - use new base image for build & release 69bd9a85 - TGP - fix test and use latest coveralls tool 52555fc7 - Tom Pallister - switch to main for default branch (#1559) e5ee57bf - Tom Pallister - Feat/net6.0 upgrade (#1558)
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/17.0.1...18.0.0
Read the Docs: Ocelot 17.0 with PDF
Read the Docs: Ocelot 17.0 with PDF
3dcc6b6d - TGP - Merge branch 'feat/fix-build' into develop ba4b7672 - TGP - use new deletedir api 47a024b8 - TGP - fix cake.json version 096f94d9 - TGP - update nuget packages to reference ocelot logo from GitHub ff6f6e38 - TGP - update nuget packages to reference ocelot logo from GitHub 77c6c30e - TGP - add ocelot logo to repo 3ef6abd7 - TomPallister - +semver: breaking bump to version 17.0.0 b46fedac - TomPallister - rename authorisation to authorization b2dd70f5 - TomPallister - release process note ede71c48 - TomPallister - updated release process ab3533bb - TomPallister - bring back develop f62ed72d - TomPallister - all packages upgraded and tests passing 17b0555f - TomPallister - tests passing 32551624 - TomPallister - wip tests failing 6eed692c - TomPallister - more package updates ebf85326 - TomPallister - removed rafty and updated more packages b356539c - TomPallister - update nuget packages and graphql example fdad2bb3 - TomPallister - update circle build image 9bc5ad1c - TomPallister - dont need this a39b5fd5 - TomPallister - dont need .config bdefa2de - TomPallister - dont need .config 03c8cd6a - TomPallister - works on linux de0f4f97 - TomPallister - build finally working....MAGIC 94ce0224 - TomPallister - wip 3a8d55f7 - TomPallister - Merge branch 'feat/net5upgrade' of github.com:ThreeMammals/Ocelot into feat/net5upgrade 6e1dc3fd - TomPallister - wip f4131028 - TomPallister - wip 7e2b312f - TomPallister - Merge branch 'feat/net5upgrade' of github.com:ThreeMammals/Ocelot into feat/net5upgrade 730c940c - TomPallister - wip ef69429d - TomPallister - mono complete 71a1053d - TomPallister - build works on windows a5a1606c - TomPallister - upgrade dotnet test and coverages packages 1185576b - TomPallister - wip 0fab351c - TomPallister - move to dotnet tools for cake 4b23e0ce - TomPallister - line endings f16cdd86 - TomPallister - fix tests and line endings c1776fb5 - TomPallister - fix warnings 7f49bf5f - TomPallister - wip a9eec31a - TomPallister - fix code broken after net5.0 upgrade 1c6bfc33 - TomPallister - add make and build tools to image 7254d4d1 - TomPallister - +semver: breaking upgrade base build image to net5.0 708b5758 - TomPallister - upgrade csproj to net5.0
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/17.0.0...17.0.1
Read the Docs: Ocelot 17.0 with PDF
Read the Docs: Ocelot 17.0 with PDF
9abd47b0 - Tom Pallister - +semver: breaking bump to version 17.0.0 (#1392)
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/16.0.0...17.0.0
Nothing published for this version
c3a0cf11 - TomPallister - Merge branch 'kjellegafvelin-master' 2b8c8727 - TomPallister - Revert "Feat/opentracing (#1243)" 865520f2 - Tom Pallister -
c3a0cf11 - TomPallister - Merge branch 'kjellegafvelin-master' 2b8c8727 - TomPallister - Revert "Feat/opentracing (#1243)" 865520f2 - Tom Pallister - Feat/opentracing (#1243) 21b9d73c - TomPallister - tweaks 56fe7b5b - TomPallister - wip
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/16.0.0...16.0.1
Read the Docs: Ocelot 16.0 with PDF
Read the Docs: Ocelot 16.0 with PDF
3439be89 - Tom Pallister - Rename all ReRoute to Route +semver: breaking
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/15.0.0...16.0.0
fe3e8bd2 - Tom Pallister - Remove Ocelot specific Middleware to make Ocelot more compatible with kestrel middleware and get ready for YARP
Read the Docs: Ocelot 15.0
fe3e8bd2 - Tom Pallister - Remove Ocelot specific Middleware to make Ocelot more compatible with kestrel middleware and get ready for YARP
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/15.0.6...15.0.7
99a15d86 - jlukawska - Fix/1157 fix UpstreamHost validation
99a15d86 - jlukawska - Fix/1157 fix UpstreamHost validation (#1169)
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/15.0.5...15.0.6
53d7f560 - TomPallister - Merge branch 'EngRajabi-feature_distributeCache' 8b098d23 - TomPallister - removed old memory cache and added a few tests fo
53d7f560 - TomPallister - Merge branch 'EngRajabi-feature_distributeCache' 8b098d23 - TomPallister - removed old memory cache and added a few tests for new asp memory cache b4c29fc7 - TomPallister - Merge branch 'feature_distributeCache' of https://github.com/EngRajabi/Ocelot into EngRajabi-feature_distributeCache adffb1e2 - Mohsen Rajabi - add asp memory cache
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/15.0.4...15.0.5
c004c43f - TomPallister - Merge branch 'samirsyed-master' b7cfac93 - TomPallister - more tests and docs 6c20b117 - TomPallister - Merge branch 'master
c004c43f - TomPallister - Merge branch 'samirsyed-master' b7cfac93 - TomPallister - more tests and docs 6c20b117 - TomPallister - Merge branch 'master' of https://github.com/samirsyed/Ocelot into samirsyed-master f63afbf1 - Samir Syed - Added UpstreamHost placeholder to identify host from which request origination
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/15.0.3...15.0.4
59af924f - TomPallister - Merge branch 'DavidLievrouw-CustomLoadBalancers' 7408060f - TomPallister - more error handling and docs c9483cda - TomPallis
59af924f - TomPallister - Merge branch 'DavidLievrouw-CustomLoadBalancers' 7408060f - TomPallister - more error handling and docs c9483cda - TomPallister - tests to handle some error cases and docs b300ed9a - TomPallister - small refactor 2843cdbc - TomPallister - removed tasks we dont need ccb5b841 - TomPallister - Merge branch 'CustomLoadBalancers' of https://github.com/DavidLievrouw/Ocelot into DavidLievrouw-CustomLoadBalancers 1223c198 - David Lievrouw - Add comment indicating that the FakeCustomLoadBalancer implementation is not relevant for OcelotBuilder tests. 2606d919 - David Lievrouw - Fix unit test naming issue. f9ce987c - David Lievrouw - Cover DelegateInvokingLoadBalancerCreator by unit tests. 22f304ce - David Lievrouw - Cover LoadBalancerFactory edge-case by a unit test. fd35ad05 - David Lievrouw - Add ability to register custom load balancers 80ab5f6a - David Lievrouw - Extend OcelotBuilder with overloads of the AddCustomLoadBalancer registration helper method de012a07 - David Lievrouw - Rewire LoadBalancerFactory to allow injecting custom load balancers, by introducing LoadBalancerCreators c73cf599 - David Lievrouw - Revert "Add 'Name' property to ILoadBalancer, for future use in LoadBalancerFactory." 789782c8 - David Lievrouw - Add 'Name' property to ILoadBalancer, for future use in LoadBalancerFactory.
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/15.0.2...15.0.3
d58f3147 - TomPallister - Merge branch 'DavidLievrouw-ServiceProviderConfigurationScheme' 169b3339 - TomPallister - updated docs c8c3d128 - TomPallist
d58f3147 - TomPallister - Merge branch 'DavidLievrouw-ServiceProviderConfigurationScheme' 169b3339 - TomPallister - updated docs c8c3d128 - TomPallister - Merge branch 'ServiceProviderConfigurationScheme' of https://github.com/DavidLievrouw/Ocelot into DavidLievrouw-ServiceProviderConfigurationScheme 20fd3e01 - David Lievrouw - Fix issue and test after cherry-pick. bc42f041 - David Lievrouw - Fix tests that are failing on AppVeyor. cd3dc00c - David Lievrouw - Add ability to specify scheme of ServiceProviderConfiguration
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/15.0.1...15.0.2
2f97913f - TomPallister - Merge branch 'jlukawska-feature/603-bad-gateway' cdbd8e85 - TomPallister - http error code tests and docs 3dfcff82 - TomPall
2f97913f - TomPallister - Merge branch 'jlukawska-feature/603-bad-gateway' cdbd8e85 - TomPallister - http error code tests and docs 3dfcff82 - TomPallister - Merge branch 'feature/603-bad-gateway' of https://github.com/jlukawska/Ocelot into jlukawska-feature/603-bad-gateway 8ead5114 - jlukawska - update acceptance tests f922f0c0 - jlukawska - Merge pull request #3 from ThreeMammals/master cbb21a13 - jlukawska - #603 return 502 on HttpRequestException 8985495f - jlukawska - Merge remote-tracking branch 'origin/develop' into feature/603-bad-gateway 68e3ae8c - jlukawska - #603 return 502 on HttpRequestException f35a07a3 - jlukawska - #603 return 502 when request cannot be completed
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/15.0.0...15.0.1
Read the Docs: Ocelot 15.0 with PDF
Read the Docs: Ocelot 15.0 with PDF
77d4bb15 - TomPallister - Merge branch 'ussamoo-feature/#1126' 6e5471a7 - TomPallister - Refactored k8s endpoints PR +semver: major 84907bd4 - WebMed - Update KubeServiceDiscoveryProviderTests ae9f05ef - WebMed - Merge remote-tracking branch 'upstream/master' into feature/#1126 88034a5f - WebMed - Updated KubeProvider to use pod endpoints instead of service
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.0...15.0.0
fd7c6d7a - Tom Pallister - Feat/release queue
fd7c6d7a - Tom Pallister - Feat/release queue (#1192)
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.1.2...14.1.3
84821c6c - Pedram Rezaei - Updated packages
84821c6c - Pedram Rezaei - Updated packages (#1133)
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.1.1...14.1.2
4110837a - Alazari-main - Fix code-blocks in kubernetes.rst
4110837a - Alazari-main - Fix code-blocks in kubernetes.rst (#1128)
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.1.0...14.1.1
347ea728 - Tom Pallister - #1152: dont push releasenotes.md to GitHub +semver: minor 783a77aa - Tom Pallister - #1151: format release notes as JavaScr
347ea728 - Tom Pallister - #1152: dont push releasenotes.md to GitHub +semver: minor 783a77aa - Tom Pallister - #1151: format release notes as JavaScript string for GitHub 1a280ddd - Tom Pallister - #1150: added simple way to get release notes using cake and git
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.12...14.1.0
- #1115 find available ports to use in acceptance tests by @jlukawska Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.11...14.0.12
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.11...14.0.12
check we are on master before pushing coverage report by @TomPallister in https://github.com/ThreeMammals/Ocelot/pull/1143
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.10...14.0.11
Add DownstreamHttpVersion property for Http/2 WebServer by @andreatosato in https://github.com/ThreeMammals/Ocelot/pull/1127
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.9...14.0.10
Please note that some of the packages are deprecated! To watch the status of each package and its repository, go to the Release Radar status page.
<!-- {0} -> 25.0.2 {1} -> 25.0.1 Tag to substitute: 25.0.2 https://www.nuget.org/packages/Ocelot/25.0.2 -->
Version 25.0.2 includes upgraded solutions of all Ocelot packages based on .NET SDK 10.0.402, released on October 13, 2026. For more details about SDK 10.0.402 (also known as Runtime 10.0.13), see the .NET 10.0.13 Release Notes as part of the .NET 10 Release Notes.
Affected Milestones: .NET 10, Summer '25
Hotfixed versions: 24.1.0 ("Globality"), 25.0.0, 25.0.1 (".NET 10")
Read the Docs: Ocelot 25.0 with PDF
:fire: Hotfixed bugs are #2352 and #2428. A sincere and heartfelt "Thank You" goes to @xiexihui, @elenacalugaru, and @alin-popa for reporting these critical bugs. :heart: A special "Thank You" goes to Beka Mosulishvili (@bekammo) for the professional and timely contributions in pull requests #2427 and #2429.
Interface Breaking Changes:
The IDownstreamRouteProvider.Get method now returns Response<Route> (previously Response<DownstreamRouteHolder>). The DownstreamRouteHolder class has been removed. Placeholders are now stored directly on Route.TemplatePlaceholderNameAndValues. Custom implementations of IDownstreamRouteProvider and any code that references DownstreamRouteHolder require updates and recompilation.
Other changes affecting deployments:
RegexParseException on certain browser headers such as sec-ch-ua). An empty collection is returned instead. Static routing is unchanged.<!--
net10.0, version 25.0) a.k.a. the .NET 10 releaseMilestone: .NET 10 :point_left: Codenamed: .NET 10 Read the Docs: Ocelot 25.0 with PDF Target Framework Monikers:
net8.0,net9.0,net10.0
On November 11th, 2025, the .NET team announced the release of the .NET 10 framework:
This major release upgrades the Ocelot package TFMs to net10.0 in addition to the current net8.0 and net9.0. Thus, the current Ocelot supported frameworks are .NET 8 LTS, .NET 9 STS, and .NET 10 LTS.
Additionally, in this major release the Ocelot team focused on preparing the codebase and its ecosystem for the .NET 10 SDK (.NET 10 milestone), while also extracting several integrated extension packages from the v24.1 monorepo into their own dedicated repositories to speed up delivery and reduce release coupling. As a result of these DevOps activities, the Ocelot repository now hosts only two package projects — Ocelot (src folder) and Ocelot.Testing (testing folder) — along with two solutions, Ocelot.slnx and Ocelot.Samples.slnx, which can be opened or built only if the .NET 10 SDK is installed. Since the extension packages now live in separate repositories, a new Release Radar status page has been introduced to track their progress.
This major version also includes the following feature updates:
ocelot.*.json files, keeping users' extended properties available during Ocelot app startup and at runtime via the standard IConfiguration service in the DI container.Finally, because the repository has a new folder structure, the development team recommends recloning or even reforking the Ocelot repository for a successful upgrade to the new version in order to avoid potential build errors.
As a best practice, the release strategy has been aligned with .NET SDK monthly patches (usually available between the 10th and 15th of each month). The development team will therefore also aim to roll out monthly Ocelot patches that reference the new .NET SDK patched versions. Ocelot patches will follow the form of a beta or patched version major.minor.*, where * is the Ocelot patch number corresponding to the newly available .NET SDK patch.
Ideally, the Ocelot team expects accelerated releases with more frequent minor/patch versions, because DevOps is now prepared for the new release strategy and offers fast delivery.
For successful contributions, maintainers will announce an identity-verification procedure (details for first-time contributors will be published soon).
:star: Quality of Service: A "Built-in Circuit Breaker" feature implementation was added by @ocelot-ot in pull request #2385 — no Polly required. :star:
Ocelot's QoS schema no longer strictly depends on the external Ocelot.QualityOfService.Polly package to provide circuit breaking and timeout enforcement.
A lightweight, thread-safe circuit breaker (Closed → Open → HalfOpen → Closed) ships in the Ocelot core package, supporting both count-based and FailureRatio-based modes.
The two implementations are mutually exclusive: the last of AddQualityOfService() or AddPolly() registered on the OcelotBuilder wins.
See the built-in QoS documentation for full details, including the AddQualityOfService<THandler>() extensibility point for overriding server error codes.
WebSockets: The "Overridable WebSocket buffer size" feature and custom middleware injection were added by @erannevo in pull request #2387.
The previously hard-coded DefaultWebSocketBufferSize is now a protected virtual property that can be overridden by subclassing.
The Middleware Injection feature was extended with a WebSocketsProxyMiddleware override on the OcelotPipelineConfiguration class, allowing a fully custom WebSocket middleware to be injected into the pipeline.
Refer to the "Sample" section to understand how to utilize the new feature.
WebSockets: The "SecurityOptions support for the WebSocket pipeline" feature was added by @CurtisRobertOliver in pull request #2406.
Previously, IP allow/block-list Routing "Security Options" were not enforced for WebSocket upgrade requests (a.k.a. the CONNECT HTTP method), allowing them to bypass IP security.
WebSocket upgrade requests are now intercepted by the same IPSecurityPolicy used for regular HTTP requests, and denied upgrades now correctly return 403 Forbidden.
:star: Configuration: The "Extend configuration with Custom Properties" feature was implemented by @jlukawska in pull request #1183. :star:
Ocelot's configuration builder now merges custom (non-schema) JSON properties defined across multiple ocelot.*.json files using Newtonsoft's JToken merge functionality, instead of the last-loaded file silently overwriting properties from previous files in the Routes collection.
This also applies to the DynamicRoutes collection and the GlobalConfiguration section. See the updated Configuration documentation, especially the "Extend configuration with Custom Properties" section, and the Configuration Sample app for details.
:airplane: Aggregation: A new "Manual/custom aggregators for Complex Aggregation" feature has been published (originally developed by @TomPallister in pull requests #248, #310). :airplane:
While working on bug #2248 in pull request #2328 by @NandanDevHub, the development team uncovered an undocumented feature in the Multiplexer namespace and decided to publish this pilot feature in the "Aggregate Manually?" documentation. The feature is based on the IResponseAggregator interface, whose correct application is currently unclear. The Ocelot team will test it further in upcoming releases, develop best practices, create a sample app, and inform the community. For this reason we warn that the feature is still in pilot status. :airplane:
Extension packages extraction #2334: The Ocelot team continued extracting integrated extension packages out of the monorepo into their own dedicated repositories, each with an independent release cycle:
Ocelot.Provider.Eureka, see issue #2371) in pull request #2372Ocelot.Provider.Polly, see issue #2378) in pull request #2380Ocelot.Provider.Consul, see issue #2378) in pull request #2388Ocelot.Provider.Kubernetes, see issue #2378) in pull request #2404This keeps the Ocelot core repository lean, avoids delays caused by the integrated packages' own release schedules, and lets each provider evolve independently. Consult the Caching, Tracing, Service Discovery, and Kubernetes chapters for package-specific upgrade notes. Please note that some of the packages are deprecated! To watch the status of each package and its repository, go to the Release Radar status page.
Kubernetes: The "PollKube provider" was redesigned by @raman-m in pull request #2358.
The PollKube discovery provider was redesigned to utilize PeriodicTimer (introduced in .NET 6). The provider is based on an "active polling" strategy that requires stable behavior and careful management of timing events in multi-threaded scenarios. The new PeriodicTimer is designed for thread safety, and its callbacks replace the old Timer callbacks, which work fine in a synchronous flow.
Please note that the PollKube discovery provider is now part of the Ocelot.Discovery.KubeClient package.
DevOps: Extensive testing and tooling modernization was carried out by contributors ahead of .NET 10 milestone:
.sln → .slnx), by @raman-m in pull request #2354.Microsoft.Testing.Platform framework (by @raman-m in #2392).coverlet.runsettings (by @ocelot-ot in #2365).10.0.* (.NET Runtime 10.0.*), by @raman-m and @ocelot-ot in pull requests #2367, #2389, #2402, and #2409.The updated documentation also highlights the deprecation of certain packages through multiple notes and warnings. With the Obsolete attributes in place, C# developers will notice several warnings in the build logs during compilation.
Routing: Issue #2346 was patched by @bhargav-polara in pull request #2351.
This fixes a bug where downstream URL query parameter names could be corrupted if they contained a placeholder with a non-empty value.
The DownstreamUrlCreatorMiddleware query-string merging algorithm was refactored to take full advantage of ASP.NET Core's QueryHelpers.
Error Handling: Issue #2376 was patched by @Majdi-Zlitni in pull request #2379.
Requests containing non-ASCII characters in HTTP header values previously surfaced as an unhandled HttpRequestException and an HTTP 502 Bad Gateway response.
Ocelot now catches this HttpRequestException and maps it to a 400 Bad Request response, in line with RFC 7230 "Field Parsing" rules.
:fire: WebSockets: Critical issue #2403 was patched by @CurtisRobertOliver in pull request #2406. :fire:
Previously, IP allow/block-list Routing "Security Options" were not enforced for WebSocket upgrade requests, allowing them to bypass IP security.
WebSocket upgrade requests are now intercepted by the same IPSecurityPolicy used for regular HTTP requests, and denied upgrades now correctly return 403 Forbidden.
This critical security issue was detected by security scanners on GitHub after the bug was reported. :see_no_evil: Many thanks to George Chen (@geo-chen) for reporting this critical bug.
Aggregation: Issue #2248 was patched by @NandanDevHub in pull request #2328.
Complex Aggregation routes configured with the RouteKeysConfig array now correctly map route keys to the corresponding aggregator context, fixing a bug where keys could be mismatched or dropped during multiplexing.
Administration: Issue #989 was patched by @mmustafasenoglu in pull request #2412.
The {adminPath}/configuration and {adminPath}/outputcache/{region} endpoints are now decorated with [ApiExplorerSettings(IgnoreApi = true)] so that they no longer appear in Swagger/OpenAPI documentation generated for the downstream API surface.
-->
<details><summary><b>Logbook</b></summary>
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.8...14.0.9
:one:<sup>st</sup> :1st_place_medal: goes to Ocelot Robot for delivering 3 features :two:<sup>nd</sup>:2nd_place_medal: goes to jlukawska for delivering 1 feature in 32 files changed :three:<sup>rd</sup> :3rd_place_medal: goes to Eran Nevo for delivering 1 feature in 21 files changed :four:<sup>th</sup> place goes to Majdi Zlitni for delivering 1 feature in 17 files changed :five:<sup>th</sup>place goes to CurtisRobertOliver for delivering 1 feature in 15 files changed :six:<sup>th</sup> place goes to Methran G. for delivering 1 feature in 13 files changed with 663 insertions :seven:<sup>th</sup> :7th_place_medal: goes to Nandan Parmar for delivering 1 feature in 13 files changed with 484 insertions :eight:<sup>th</sup> :8th_place_medal: goes to bhargav-polara for delivering 1 feature in 7 files changed :nine:<sup>th</sup> :9th_place_medal: goes to mmustafasenoglu for delivering 1 feature in 4 files changed :ten<sup>0th</sup> :10th_place_medal: goes to Mi┼Иo Martiniak for delivering 1 feature in 0 files changed :one::zero:
:heart: :blue_heart: :green_heart: :orange_heart: :yellow_heart: :light_blue_heart: :purple_heart: :grey_heart: :black_heart:
------==< TOP Contributors >==------ 1<sup>st</sup> :1st_place_medal: goes to Ocelot Robot for delivering 3 features 2<sup>nd</sup> :2nd_place_medal: goes to jlukawska for delivering 1 feature in 32 files changed 3<sup>rd</sup> :3rd_place_medal: goes to Eran Nevo for delivering 1 feature in 21 files changed 4<sup>th</sup> :orange_heart: goes to Majdi Zlitni for delivering 1 feature in 17 files changed 5<sup>th</sup> :yellow_heart: goes to CurtisRobertOliver for delivering 1 feature in 15 files changed 6<sup>th</sup> :light_blue_heart: goes to Methran G. for delivering 1 feature in 13 files changed with 663 insertions 7<sup>th</sup> :purple_heart: goes to Nandan Parmar for delivering 1 feature in 13 files changed with 484 insertions 8<sup>th</sup> :grey_heart: goes to bhargav-polara for delivering 1 feature in 7 files changed 9<sup>th</sup> :black_heart: goes to mmustafasenoglu for delivering 1 feature in 4 files changed 10<sup>th</sup> :heart: goes to Mi┼Иo Martiniak for delivering 1 feature in 0 files changed
Feb 9, 2020: https://github.com/ThreeMammals/Ocelot/commit/ddf8b01d364dfd17f781c1ce74c586d4ddfa570c
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.6...14.0.8
Method Transformation feat Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.6...14.0.7
Method Transformation feat
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.6...14.0.7
RABC typo fix by @PavPS in https://github.com/ThreeMammals/Ocelot/pull/1123
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.5...14.0.6
Feat/test chris by @TomPallister in https://github.com/ThreeMammals/Ocelot/pull/1122
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.4...14.0.5
Use registered scheme by @pengweiqhca in https://github.com/ThreeMammals/Ocelot/pull/1087
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.3...14.0.4
Develop by @TomPallister in https://github.com/ThreeMammals/Ocelot/pull/1106
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.2...14.0.3
Feat/shore up tests by @TomPallister in https://github.com/ThreeMammals/Ocelot/pull/1105
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.1...14.0.2
slack link in readme by @TomPallister in https://github.com/ThreeMammals/Ocelot/pull/1104
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/14.0.0...14.0.1
Update README.md by @aresofficial in https://github.com/ThreeMammals/Ocelot/pull/1043
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/13.8.0...14.0.0
Nothing published for this version
Feat/basic sample by @TomPallister in https://github.com/ThreeMammals/Ocelot/pull/1102
Full Changelog: https://github.com/ThreeMammals/Ocelot/compare/13.8.4...13.8.5
One column per quarter.