Ocelot Versions Save

• Configuration: New Merging files to memory feature by @ebjornset
• Dependency Injection: Added new overloaded AddOcelot methods by @ebjornset
• Quality of Service: Support of new Polly v8 syntax and new Extensibility feature by @RaynaldM

• Ocelot.Provider.Polly: Support of new Polly v8 syntax. Polly 8.0+ versions introduced the concept of resilience pipelines. All AddPolly extensions have been automatically migrated from v7 to v8. Please note that older v7 extensions are marked with the [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.

• 683 by PR 1927 New rules have been added to Ocelot's configuration validation logic to find duplicate placeholders in path templates. See more in the FileConfigurationFluentValidator class. Thanks to @AlyHKafoury!
• 1518 hotfix by PR 1986 Using the default 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!
• See all bugs of the February'24 milestone

• Configuration
• Dependency Injection
• Quality of Service
• Service Fabric

• _{334432fe by Raman Maksimchuk on Friday, March 29 at 20:18 →} Release 23.2 artifacts | +semver: minor (#2022)
• _{4f0e483e by Aly Kafoury on Tuesday, March 26 at 14:35 →} #683 Validate placeholder duplicates in path templates (#1927)
• _{ded4d7e9 by Adrien Hupond on Thursday, March 21 at 9:54 →} #1518 Create building the IServiceCollection (#1986)
• _{d6eefc89 by Raynald Messié on Friday, March 15 at 13:46 →} #1875 Use Polly v8 syntax (#1914)
• _{84bd6e4f by Eirik Bjornset on Friday, March 15 at 9:05 →} #1216 #1955 #1956 Overloaded AddOcelot method to support merging of configuration files to memory (#1227)

• Significant refactoring and design review of the Multiplexer
• Optimizing multiplexer performance: HttpContext is not copied when there is only one downstream route, and etc.
• Fixed the bug in the multiplexer: HttpContext.User information was not copied if there was more than one downstream request.

• Correction of the bug when creating requests: The header Transfer-Encoding: chunked was present even when there was no content or the request body size was 0. These cases are now addressed.

• Quality of Service: Possibility of implementation of custom Polly v8.2 providers. New AddPolly extension methods.
• Load Balancer: Extension of the route key format, ensuring that the key remains unique for cases of UpstreamHost route property and ServiceName vs ServiceNamespace properties in Consul setup.
• Error Status Codes: When 413 Content Too Large, Ocelot now returns a 413 PayloadTooLargeError (Ocelot error code 41).

• Request Aggregation

• See all bugs of the January'24 milestone

• _{5ec192a by Raman Maksimchuk on Monday, March 4 at 14:12 →} Release 23.1 artifacts | +semver: minor
• _{36986d6 by Guillaume Gnaegi on Friday, March 1 at 18:33 →} #1825 #1330 #1287 #1069 Improvements of the multiplexing middleware (#1826)
• _{42ac3ca by Guillaume Gnaegi on Friday, March 1 at 12:00 →} #749 Bad error handling for IOException while reading incoming request body (#1769)
• _{319e397 by Alexander Reinert on Thursday, February 29 at 22:16 →} #1971 #928 Avoid content if original request has no content and avoid Transfer-Encoding: chunked if Content-Length is known (#1972)
• _{8845d1b by Steven on Thursday, February 29 at 9:44 →} #849 #1496 Extend the route key format used for load balancing making it unique (#1944)
• _{171e3a7 by Masoud Bahrami on Tuesday, February 27 at 19:05 →} Logging bug in HttpRequesterMiddleware (#1953)
• _{0404c24 by Raynald Messié on Monday, February 26 at 9:24 →} #1844 More open customization of Polly use (#1974)
• _{108bede by Ugway77 on Thursday, February 22 at 23:38 →} #1396 Lost context User in MultiplexingMiddleware (#1462)
• _{a9dff7c by Chris Williams on Thursday, February 22 at 4:25 →} Fix typo in the name of the DistributedCacheRateLimitCounterHandler class (#1969)

• 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 Ocelot ver. 23.0 is ready for use in production environments—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.

• 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.

• AuthenticationMiddleware: Added new Multiple Authentication Schemes feature by @MayorSheFF
• OutputCacheMiddleware, RequestIdMiddleware: Added new Cache by Header Value feature by @EngRajabi, and redesigned as Default CacheKeyGenerator feature by @raman-m
• DownstreamUrlCreatorMiddleware: Fixed bug for ending/omitting slash in path templates aka Empty placeholders feature by @AlyHKafoury
• ConfigurationMiddleware, HttpRequesterMiddleware, ResponderMiddleware: System upgrade for Custom HttpMessageInvoker pooling feature by @ggnaegi
• DownstreamRequestInitialiserMiddleware: System upgrade for Performance of Request Mapper feature by @ggnaegi

• Authentication
• Caching
• Kubernetes
• Routing

• See all bugs of the Nov-December'23 milestone

• The Ocelot.Benchmarks testing project has been updated with new PayloadBenchmarks and ResponseBenchmarks by @ggnaegi
• The Ocelot.AcceptanceTests testing project has been refactored by @raman-m using the new AuthenticationSteps class, and more refactoring will be done in future releases

• _{290fbde8 by Raman Maksimchuk on Tuesday, February 13 at 14:29 →} Release 23.0 | Artifacts | +semver: breaking (#1962)
• _{a1607f5a by ZisisTsatsas on Monday, February 12 at 9:17 →} [#1527 #1529] Breaking change to the class renaming of Kube service discovery provider (#1954)
• _{c9510b1c by Igor on Monday, February 5 at 19:39 →} #740 #1580 Support multiple authentication schemes in one route (#1870)
• _{f4803c24 by Aly Kafoury on Thursday, January 18 at 20:23 →} #748 Match Route configurations for upstream paths when empty Catch-All placeholders at the end of template (#1911)
• _{5e7e76be by Guillaume Gnaegi on Thursday, January 18 at 12:43 →} #356 #695 #1924 Custom HttpMessageInvoker pooling (#1824)
• _{bb795876 by Guillaume Gnaegi on Monday, December 18, 2023 at 12:54 →} #1724 Reverting back HttpClient full buffering (#1853)
• _{ba641b24 by Raman Maksimchuk on Thursday, December 14, 2023 at 12:18 →} #1172 Default CacheKeyGenerator (#1849)
• _{a17242d0 by Guillaume Gnaegi on Wednesday, December 13, 2023 at 20:42 →} #827 #1679 Improve performance of Request Mapper (#1724)
• _{6b1f3326 by Tanmay Seth on Friday, December 8, 2023 at 5:49 →} #649 Acceptance tests (#1846)
• _{e92b103 by Mohsen Rajabi on Thursday, October 19, 2023 at 10:40 →} Cache by header value: a new Header property in (File)CacheOptions configuration of a route (#1172)

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.

There is a lot of community interest in this HTTP-based protocol.

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.

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.

Brainstorming to redesign Rate Limiting, Websockets. More details in future release notes.

Planning of support for Swagger and gRPC proto. More details in future release notes.

• _{37265ad4 by Raman Maksimchuk on Friday, December 08 at 11:46 →} Release 22.0.1
• _{ab79b01b by Alvin Huang on Friday, December 08 at 03:59 →} #1833 Default timeout(90s) of downstream requests is broken (#1834)

• 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

• 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

• Logging
• Request ID
• Routing
• Websockets

• 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

• _{349825f9 by raman-m on Tuesday, November 28 at 15:45 →} Switch off the PublishToNuget task
• _{22bc5b69 by raman-m on Monday, November 27 at 22:05 →} Release 22.0 | +semver: breaking
• _{b2246a59 by Raynald Messié on Friday, November 24 at 23:21 →} #1783 Less logs for circuit breakers (Polly exceptions) (#1786)
• _{388ebc39 by Guillaume Gnaegi on Friday, November 24 at 21:59 →} #1744 Avoid calls to 'Logger.Log' if LogLevel not enabled in appsettings.json (#1745)
• _{04ad9bf8 by raman-m on Tuesday, November 21 at 19:56 →} Resolve issues with projects after auto-merging. Format Document
• _{ec555044 by Samuel Poirier on Saturday, November 04 at 13:15 →} #1179 Add missing documentation for Secured WebSocket #1180
• _{dabb4b5e by Guillaume Gnaegi on Saturday, November 04 at 09:27 →} #1550 #1706 Addressing the QoS options ExceptionsAllowedBeforeBreaking issue (#1753)
• _{ae43f32f by Stjepan on Wednesday, November 01 at 12:41 →} #952 #1174 Merge query strings without duplicate values (#1182)
• _{ab3d8e63 by jlukawska on Friday, October 27 at 21:20 →} Find available port in integration tests (#1173)
• _{3b776a75 by Raynald Messié on Friday, October 13 at 18:40 →} #1712 Bump to Polly 8.0 (#1714)

• _{50ff7683 by raman-m on Monday, November 20 at 23:43 →} +semver: breaking | Release 21.0
• _{7d936233 by Raman Maksimchuk on Monday, November 20 at 23:02 →} .NET8 Release artifacts (#1792)
• _{24b507ee by Guillaume Gnaegi on Monday, November 20 at 00:41 →} #1787 Upgrade to .NET 8 (#1789)

• _{f5d94c99 by @raman-m on Friday, October 27 at 15:08 →} Prepare for the 20.0.1 release
• _{640b0051 by Raman Maksimchuk on Thursday, October 26 at 14:07 →} #1731 Docs for 20.0 release (#1754)
• _{0a05369e by Guillaume Gnaegi on Sunday, October 15 at 22:09 →} #1731 Read the Docs configuration file v2 (#1733)

• _{65be4b65 by raman-m on Friday, October 06 at 20:52 →} Fix Git command placeholder bug
• _{d2f76ae0 by raman-m on Friday, October 06 at 19:44 →} +semver: breaking | Polish Apple release | 2nd build
• _{adac0a24 by raman-m on Friday, October 06 at 10:20 →} Polish Apple release
• _{fcdd2744 by Raman Maksimchuk on Friday, October 06 at 09:07 →} A brand new Release Notes feature for Releases being made by 'build.cake' script (#1716)
• _{e5f31ef0 by Raman Maksimchuk on Monday, October 02 at 19:17 →} Follow up #1670: Fix StyleCop issues and improve the code (#1711)
• _{e950cf2f by Ben Bartholomew on Saturday, September 30 at 14:50 →} #653 Adding null check for downstreamResponse (#1334)
• _{5a81cce1 by Freddy on Saturday, September 30 at 19:34 →} Second parameter of Substring is wrong in HeaderFindAndReplaceCreator (#1424)
• _{5dbbbefc by Fabrizio Mancin on Saturday, September 30 at 16:26 →} #1400 Manage multiple patterns for allowed/blocked IPs via Security Options config section (#1399)
• _{cc0b9b83 by Kevin Grossmann on Friday, September 29 at 20:42 →} Ignore port when using UpstreamHost option (#1505)
• _{f8eb5e1c by Guillaume Gnaegi on Friday, September 29 at 19:44 →} #1634 #1487 #1329 #1304 #1294 #793 Consul polling of services: enhancements and fix errors (#1670)
• _{ab294423 by Roman on Friday, September 29 at 11:27 →} #1509 #1683 Replace non-WS protocols for the 'ClientWebSocket' in WebSocketsProxyMiddleware (#1689)
• _{190b0017 by leonluc-dev on Thursday, September 28 at 18:14 →} #1225 Update ServiceDiscovery documentation and samples to include Custom Providers (#1656)
• _{fa179bf4 by zhangq on Thursday, September 28 at 23:04 →} #1375 #1237 #925 #920 Fix DownstreamRoute DangerousAcceptAnyServerCertificateValidator (#1377)
• _{5fd5bf93 by Raman Maksimchuk on Monday, September 25 at 18:00 →} #1681 'using' statements life hacks (#1682)
• _{8b892574 by Raman Maksimchuk on Monday, September 25 at 16:54 →} #1700 Add sequential tests with disabled parallelization (#1705)
• _{fdad15d4 by Guillaume Gnaegi on Monday, September 25 at 14:15 →} #1700 Create custom Ocelot config file when instantiating steps during parallel execution (#1703)
• _{75cd0b30 by Raman Maksimchuk on Monday, September 25 at 10:51 →} #1677 #1686 United documentation update (#1678)
• _{b7976fcc by guoyongchang on Saturday, September 23 at 09:30 →} #1351 #1510 New AddOcelot extensions to support custom ASP.NET MVC pipeline building via the IMvcCoreBuilder interface (#1655)
• _{4d245ec7 by Vijay Karavadra on Saturday, September 23 at 19:19 →} #1228 #1235 #1247 Overloaded AddOcelot method for dynamic FileConfiguration construction (#1569)
• _{5ad807d7 by jlukawska on Saturday, September 23 at 11:12 →} #893 Problems to cancel a request (CancellationToken) (#1367)
• _{b27761f4 by jlukawska on Saturday, September 23 at 10:43 →} #1057 #1068 Add service discovery logs (#1366)
• _{ec85b132 by jlukawska on Friday, September 22 at 21:39 →} #1288 Query string char missing (#1335)
• _{8893f049 by Marco on Friday, September 22 at 21:25 →} fix: minor grammar fix in default rate limit response message (#1639)
• _{e6081cef by Thiago Loureiro on Friday, September 22 at 21:15 →} Fixed logger message typos in the OutputCacheMiddleware class (#1315)
• _{21bc4a4a by DanHarltey on Friday, September 22 at 20:05 →} #908 Quality of Service - Configuration (#1279)
• _{455d7d3f by Anthony Steele on Friday, September 22 at 19:45 →} Exception mapper naming (#1211)