Releases: ThreeMammals/Ocelot
23.3.5
π¦ Documentation patch (version 23.3.5), technical release
Read the Docs: Ocelot 23.3
PDF Doc: Ocelot 23.3
Hot fixed version: 23.3.4
βΉοΈ About
This documentation patch pertains to HTML and PDF document layouts.
No NuGet packages have been uploaded.
23.3.4
π₯ Hot fixing v23.3 (version 23.3.4) aka Blue Olympic Balumbes release
Codenamed: Blue Olympic Fiend
Read the Docs: Ocelot 23.3
Hot fixed versions: 23.3.0, 23.3.3
Milestone: v23.3 Hotfixes
β€οΈ 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!
βΉοΈ About
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.
π§βπ» Technical Information
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).
β οΈ Breaking Changes
Listed by priority:
ILoadBalancer
interface alteration: MethodLease
is nowLeaseAsync
.
Interface FQN:Ocelot.LoadBalancer.LoadBalancers.ILoadBalancer
Method FQN:Ocelot.LoadBalancer.LoadBalancers.ILoadBalancer.LeaseAsync
DefaultConsulServiceBuilder
constructor modification: The first parameter's type has been changed fromFunc<ConsulRegistryConfiguration>
toIHttpContextAccessor
.
Class FQN:Ocelot.Provider.Consul.DefaultConsulServiceBuilder
Constructor signature:public DefaultConsulServiceBuilder(IHttpContextAccessor contextAccessor, IConsulClientFactory clientFactory, IOcelotLoggerFactory loggerFactory)
- Adjustments to
Lease
type: TheLease
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.
Honoring π aka Top Contributors π
1st π₯ goes to Roman Shevchik for delivering 1 feature in 25 files changed
2nd π₯ goes to Ben Bartholomew for delivering 1 feature in 7 files changed
3rd π₯ goes to Paul Roy for delivering 1 feature in 5 files changed
Starring β aka Release Influencers
ββ Raman Maksimchuk, @raman-m
β Roman Shevchik, @antikorol
β Ben Bartholomew, @ben-bartholomew
β Paul Roy, @PaulARoy
β Finn Fiedler, @int0x81
β Emmanuel Ferdman, @emmanuel-ferdman
β dependabot[bot], @dependabot
Features in Release 23.3.4
Milestone: v23.3 Hotfixes
Logbook
- acda395 by Raman Maksimchuk on Thursday, October 3 at 23:05 β
Release 23.3.4 artifacts | +semver: patch (#2161) - 09f2b1a by Raman Maksimchuk on Thursday, October 3 at 11:48 β
#2119 Review load balancing (2nd round) and redesignDefaultConsulServiceBuilder
withConsulProviderFactory
refactoring to make it thread safe and friendly (#2151) - 58d87c9 by Finn on Friday, September 20 at 13:59 β
#2116 Escaping unsafe pattern values ofRegex
constructor ββderived from URL query parameter values containing specialRegex
chars (#2150) - 8e66be7 by Emmanuel Ferdman on Saturday, September 14 at 20:15 β
Correct the broken link to the GraphQL sample'sREADME.md
(#2149) - c502e4f by Paul Roy on Saturday, September 14 at 18:47 β
Downgrade the Warning to Information on missingContent-Length
header inMultiplexingMiddleware
(#2146) - 19a8e2f by Roman on Wednesday, August 7 at 16:44 β
#2110 Review load balancing and independent fetching the list of services inKube
provider (#2111) - b4e21c4 by dependabot[bot] on Thursday, July 18 at 16:48 β
Bump Steeltoe.Discovery.Eureka from 3.2.5 to 3.2.8 in /src/Ocelot.Provider.Eureka (#2122) - d418b3f by Ben Bartholomew on Tuesday, July 16 at 11:52 β
#2084 Apply default config file paths inGetMergedOcelotJson
when providing thefolder
argument ofAddOcelot
(#2120)
What's Changed
- #2084 Apply default config file paths in
GetMergedOcelotJson
when providing thefolder
argument ofAddOcelot
by @ben-bartholomew in #2120 - Bump Steeltoe.Discovery.Eureka from 3.2.5 to 3.2.8 in /src/Ocelot.Provider.Eureka by @dependabot in #2122
- #2110 Review load balancing and independent fetching the list of services in
Kube
provider by @antikorol in #2111 - Downgrade the Warning to Information on missing
Content-Length
header inMultiplexingMiddleware
by @PaulARoy in #2146 - Correct the broken link to the GraphQL sample's
README.md
by @emmanuel-ferdman in #2149 - #2116 Escaping unsafe pattern values of
Regex
constructor ββderived from URL query parameter values containing specialRegex
chars by @int0x81 in #2150 - #2119 Review load balancing (2nd round) and redesign
DefaultConsulServiceBuilder
withConsulProviderFactory
refactoring to make it thread safe and friendly by @raman-m in #2151 - Release 23.3.4 artifacts | +semver: patch by @raman-m in #2161
- Release 23.3.4 | v23.3 Hotfixes | Blue Olympic Balumbes release by @raman-m in #2162
New Contributors
- @dependabot made their first contribution in #2122
- @antikorol made their first contribution in #2111
- @emmanuel-ferdman made their first contribution in #2149
- @int0x81 made their first contribution in #2150
Full Changelog: 23.3.3...23.3.4
22.0.0
October 2023 (version 22.0.0) aka Swiss Locomotive release
Codenamed as Swiss Locomotive
Read the Docs: Ocelot 22.0
Focused On
Logging feature. Performance review, redesign and improvements with new best practices to log
- Proposing a centralized
WriteLog
method for theOcelotLogger
- Factory methods for computed strings such as
string.Format
or interpolated strings - Using
ILogger.IsEnabled
before calling the nativeWriteLog
implementation and invoking string factory method
Quality of Service feature. Redesign and stabilization, and it produces less log records now.
Documentation for Logging, Request ID, Routing and Websockets
Testing improvements and stabilization aka bug fixing
Honoring π aka Top Contributors π
1st π₯ goes to Guillaume Gnaegi for delivering 2 features in 99 files changed
2nd π₯ goes to Raynald MessiΓ© for delivering 2 features in 15 files changed
3rd π₯ goes to @jlukawska for delivering 1 feature in 51 files changed
Starring β aka Release Influencers
βββ @raman-m
ββ Guillaume Gnaegi, @ggnaegi
ββ Raynald MessiΓ©, @RaynaldM
β Samuel Poirier, @sam9291
β Stjepan, @wast
β @jlukawska
Features in Release 22.0.0
Logbook
- 349825f by raman-m on Tuesday, November 28 at 15:45 β
Switch off the PublishToNuget task - 22bc5b6 by raman-m on Monday, November 27 at 22:05 β
Release 22.0 | +semver: breaking - b2246a5 by Raynald MessiΓ© on Friday, November 24 at 23:21 β
#1783 Less logs for circuit breakers (Polly exceptions) (#1786) - 388ebc3 by Guillaume Gnaegi on Friday, November 24 at 21:59 β
#1744 Avoid calls to 'Logger.Log' if LogLevel not enabled in appsettings.json (#1745) - 04ad9bf by raman-m on Tuesday, November 21 at 19:56 β
Resolve issues with projects after auto-merging. Format Document - ec55504 by Samuel Poirier on Saturday, November 04 at 13:15 β
#1179 Add missing documentation for Secured WebSocket #1180 - dabb4b5 by Guillaume Gnaegi on Saturday, November 04 at 09:27 β
#1550 #1706 Addressing the QoS options ExceptionsAllowedBeforeBreaking issue (#1753) - ae43f32 by Stjepan on Wednesday, November 01 at 12:41 β
#952 #1174 Merge query strings without duplicate values (#1182) - ab3d8e6 by jlukawska on Friday, October 27 at 21:20 β
Find available port in integration tests (#1173) - 3b776a7 by Raynald MessiΓ© on Friday, October 13 at 18:40 β
#1712 Bump to Polly 8.0 (#1714)
23.3.3
23.3.0
Spring 2024 (version 23.3.0) aka Twilight Texas release
Codenamed: Twilight Texas
Read the Docs: Ocelot 23.3
β οΈ Important information about Service Discoveryβ
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. The Kube
provider, while somewhat unstable, remains operational; however, the Consul
provider is entirely non-functional. 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 the hotfixed version 23.3.4 is expected to be available at the beginning of September 2024. We appreciate your understanding and support.
What's new?
Service Discovery: Major upgrade of Kube and Consul providers: new "Customization of services creation" feature
-
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 bothConsul
andKube
providers in service creation is achieved through the overriding of virtual methods in default implementations. The recommendation was to separate the provider's logic and introducepublic virtual
andprotected virtual
methods in concrete classes, enabling:- The use of
public virtual
methods as dictated by interface definitions. - The application of
protected virtual
methods to allow developers to customize atomic operations through inheritance from existing concrete classes. - The injection of new interface objects into the provider's constructor.
- The overriding of the default behavior of 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 - The use of
Routing: New "Routing based on Request Header" feature
- Introducing the new "Routing based on Request Header" feature by @jlukawska.
In addition to routing viaUpstreamPathTemplate
, you can now define anUpstreamHeaderTemplates
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.
Configuration: New "Custom Default Version Policy" and "Route Metadata" features
-
Introducing the "Custom Default Version Policy" feature by @ibnuda.
The configurableHttpRequestMessage.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 toConfigureKestrel
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! β
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 standardFileConfiguration
. Applying an option to a specific route required knowledge of the array index and other details that might not be readily accessible using the standardIConfiguration
orIOptions<FileConfiguration>
models from ASP.NET. Now, metadata can be directly accessed in theDownstreamRoute
object. Furthermore, metadata can also be retrieved from the global JSON section via theFileConfiguration.GlobalConfiguration
property.
For more information, see the details in PR #1843 on this remarkable feature.
Focus On
Updates of the features: Configuration, Service Discovery, Routing and Quality of Service
-
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.
Ocelot extra packages
-
-
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.
-
23.2.2
Hotfix release (version 23.2.2) for #2031 issue
Route path template placeholders and their validation rules
Special thanks to Guillaume Gnaegi and Fabrizio Mancin!
About
The bug is related to the Placeholders feature in Configuration and Routing.
The bug was introduced in version 23.2.0 as a part of PR #1927.
Breaking Change
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.
Technical info
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.
Bug Artifacts
- Released in version: 23.2.0
- Introduced in: PR #1927
- Reported bug: #2031 by @ggnaegi and tested by @Fabman08
- Hotfix PR: #2032 by @raman-m
Features in Release 23.2.2
2ded872 by Raman Maksimchuk on Friday, April 05 at 15:13 β
Release 23.2.1-2 artifacts | +semver: patch
14c6d82 by Raman Maksimchuk on Friday, April 05 at 12:57 β
#2031 Don't validate placeholders in templates (#2032)
d1855cb by Raman Maksimchuk on Thursday, April 04 at 00:17 β
#1673 #1672 Update Docker for CircleCI builds (#2030)
23.2.1
Documentation patch (version 23.2.1) for 23.2.0 release
Read the Docs: Ocelot 23.2
This is a technical release: no other information.
What's Changed
Full Changelog: 23.2.0...23.2.1
23.2.0
February 2024 (version 23.2.0) aka Lunar Eclipse release
Codenamed: Lunar Eclipse
Read the Docs: Ocelot 23.2
What's new?
- Configuration: A brand new Merging files to memory feature by @ebjornset as a part of the Merging Configuration Files one.
TheAddOcelot
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 theIConfigurationBuilder
for the well-knownIConfiguration
. You can now call anotherAddOcelot
method that adds the merged JSON directly from memory to theIConfigurationBuilder
, usingAddJsonStream
instead.
See more details in Configuration Overview of Dependency Injection. - Service Fabric: Published old undocumented "Placeholders in Service Name" feature of Service Fabric service discovery provider.
This feature by @FelixBoers is available starting from version 13.0.0. - Quality of Service: A brand new Polly v8 pipelines Extensibility feature by @RaynaldM
Focus On
Updates of the features: Configuration, Dependency Injection and QoS
- 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 extra packages
- 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 theV7
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.
Stabilization aka bug fixing
- 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 defaultIServiceCollection
DI extensions to register Ocelot services resulted in theServiceCollection
provider being forced to be created by callingBuildServiceProvider()
.
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
Documentation for version 23.2
Honoring π aka Top Contributors π
1st π₯ goes to Eirik Bjornset for delivering 1 feature in 19 files changed
2nd π₯ goes to Aly Kafoury for delivering 1 feature in 9 files changed
3rd π₯ goes to Adrien Hupond for delivering 1 feature in 6 files changed
Starring β aka Release Influencers
β Adrien Hupond, @ArwynFr
β Aly Kafoury, @AlyHKafoury
β Eirik Bjornset, @ebjornset
β Raman Maksimchuk, @raman-m
β Raynald MessiΓ©, @RaynaldM
Features in Release 23.2.0
Milestone: February'24
Logbook
- 334432f by Raman Maksimchuk on Friday, March 29 at 20:18 β
Release 23.2 artifacts | +semver: minor (#2022) - 4f0e483 by Aly Kafoury on Tuesday, March 26 at 14:35 β
#683 Validate placeholder duplicates in path templates (#1927) - ded4d7e by Adrien Hupond on Thursday, March 21 at 9:54 β
#1518 Create building theIServiceCollection
(#1986) - d6eefc8 by Raynald MessiΓ© on Friday, March 15 at 13:46 β
#1875 Use Polly v8 syntax (#1914) - 84bd6e4 by Eirik Bjornset on Friday, March 15 at 9:05 β
#1216 #1955 #1956 OverloadedAddOcelot
method to support merging of configuration files to memory (#1227)
23.1.0
January 2024 (version 23.1.0) aka Hornussen release
Codenamed as Hornussen Sport
Read the Docs: Ocelot 23.1
Focus On
Multiplexing middleware aka Request Aggregation feature
- 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.
System routing. Content streaming when Transfer-Encoding: 'chunked'
- 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.
Updates of the features: QoS, Load Balancer and Error Status Codes
- 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 code41
).
Documentation for Request Aggregation
Stabilization aka bug fixing
- See all bugs of the January'24 milestone
Honoring π aka Top Contributors π
1st π₯ goes to Guillaume Gnaegi for delivering 2 features
2nd π₯ goes to Alexander Reinert for delivering 1 feature in 8 files changed
3rd π₯ goes to Steven Liekens for delivering 1 feature in 5 files changed with 353 insertions
Starring β aka Release Influencers
ββ Guillaume Gnaegi, @ggnaegi
β Alexander Reinert, @alexreinert
β Chris Williams, @williamscs
β Masoud Bahrami, @masoud-bahrami
β Raman Maksimchuk, @raman-m
β Raynald MessiΓ©, @RaynaldM
β Steven, @sliekens
β Ugway77, @Ugway77
Features in Release 23.1.0
Milestone: January'24
Logbook
- 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 forIOException
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 inHttpRequesterMiddleware
(#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 contextUser
inMultiplexingMiddleware
(#1462) - a9dff7c by Chris Williams on Thursday, February 22 at 4:25 β
Fix typo in the name of theDistributedCacheRateLimitCounterHandler
class (#1969)
23.0.0
November-December 2023 (version 23.0.0) aka Sunny Koliada release
Codenamed as Sunny Koliada
Read the Docs: Ocelot 23.0
Focus On
System performance. System core performance review, redesign of system core related to routing and content streaming
-
Modification of the
RequestMapper
with a brand newStreamHttpContent
class, inOcelot.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 forHttpClient
. 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 extra packages. Total 3 Ocelot packs were updated
-
Ocelot.Cache.CacheManager: Introduced default cache key generator with improved performance (the
DefaultCacheKeyGenerator
class). Old version ofCacheKeyGenerator
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 6e5471a. 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.
Middlewares. Total 8 Ocelot middlewares were updated
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
Documentation for Authentication, Caching, Kubernetes and Routing
Stabilization aka bug fixing
- See all bugs of the Nov-December'23 milestone
Testing
Honoring π aka Top Contributors π
1st π₯ goes to Guillaume Gnaegi for delivering 3 features
2nd π₯ goes to Igor Polishchuk for delivering 1 feature in 25 files changed
3rd π₯ goes to Aly Kafoury for delivering 1 feature in 9 files changed
Starring β aka Release Influencers
βββ Guillaume Gnaegi, @ggnaegi
ββ Raman Maksimchuk, @raman-m
β Aly Kafoury, @AlyHKafoury
β Igor Polishchuk, @MayorSheFF
β Tanmay Seth, @ks1990cn
β Zisis Tsatsas, @ZisisTsatsas
β Mohsen Rajabi, @EngRajabi
Features in Release 23.0.0
Logbook
- 290fbde by Raman Maksimchuk on Tuesday, February 13 at 14:29 β
Release 23.0 | Artifacts | +semver: breaking (#1962) - a1607f5 by ZisisTsatsas on Monday, February 12 at 9:17 β
[#1527 #1529] Breaking change to the class renaming ofKube
service discovery provider (#1954) - c9510b1 by Igor on Monday, February 5 at 19:39 β
#740 #1580 Support multiple authentication schemes in one route (#1870) - f4803c2 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) - 5e7e76b by Guillaume Gnaegi on Thursday, January 18 at 12:43 β
#356 #695 #1924 CustomHttpMessageInvoker
pooling (#1824) - bb79587 by Guillaume Gnaegi on Monday, December 18, 2023 at 12:54 β
#1724 Reverting back HttpClient full buffering (#1853) - ba641b2 by Raman Maksimchuk on Thursday, December 14, 2023 at 12:18 β
#1172 Default CacheKeyGenerator (#1849) - a17242d by Guillaume Gnaegi on Wednesday, December 13, 2023 at 20:42 β
#827 #1679 Improve performance of Request Mapper (#1724) - 6b1f332 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)
Roadmap
We would like to share our team's plans for the future regarding: development trends, ideas, community expectations, etc.
Code Review and Performance Improvements
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.