AllowRequestContinueForThroughputControlInitError #27702

xinlian12 · 2022-03-16T02:27:14Z

Description

Issue: #20020
Summary
Currently, if throughput control controller initialized failed due to any reason, the request using throughput control will also fail. This enables the capability for customer to opt out this default behavior.

If continueOnInitError = true, request will fallback to original request flow if throughput control controller failed on initialization.
If continueOnInitError = false (also the default value), request will fail if throughput control controller failed on initialization.

How to enable continueOnInitError:
new ThroughputControlGroupConfigBuilder()
.setContinueOnInitError(true)

So the request flow:
request1 -> throughputcontrolStore -> initialize all underlying controllers -> failed -> fallbackOnInitError ? -> yes, fallback to original request flow, no fail the request
...
requestN -> throughputcontrolStore -> initialize all underlying controllers -> failed -> fallbackOnInitError ? -> yes, fallback to original request flow, no fail the request

All SDK Contribution checklist:

The pull request does not introduce [breaking changes]
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

...azure/cosmos/implementation/throughputControl/ContainerThroughputControlGroupProperties.java

.../src/main/java/com/azure/cosmos/implementation/throughputControl/ThroughputControlStore.java

azure-sdk · 2022-03-16T02:42:21Z

API changes have been detected in com.azure:azure-cosmos. You can review API changes here

API changes

+         @Beta public boolean isSuppressInitError() 
+         @Beta public ThroughputControlGroupConfigBuilder setSuppressInitError(boolean suppressInitError) 
-             V4_27_0;
+             V4_27_0,
+             V4_28_0;

azure-sdk · 2022-03-16T02:57:27Z

API changes have been detected in com.azure:azure-cosmos. You can review API changes here

API changes

+         @Beta public boolean isContinueOnInitError() 
+         @Beta public ThroughputControlGroupConfigBuilder setContinueOnInitError(boolean continueOnInitError) 
-             V4_27_0;
+             V4_27_0,
+             V4_28_0;

check-enforcer · 2022-03-16T15:31:31Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run java - [service] - ci

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/ThroughputControlGroupConfig.java

...azure/cosmos/implementation/throughputControl/ContainerThroughputControlGroupProperties.java

kushagraThapar · 2022-03-17T00:07:46Z

.../src/main/java/com/azure/cosmos/implementation/throughputControl/ThroughputControlStore.java

@@ -159,9 +147,37 @@ public void enableThroughputControlGroup(ThroughputControlGroupInternal group) {
                // We will handle the first scenario by creating a new container controller,
                // while fall back to original request Mono for the second scenario.
                return this.updateControllerAndRetry(collectionNameLink, request, originalRequestMono);
+            })
+            .onErrorResume(throwable -> {
+               if (throwable instanceof ThroughputControlInitializationException) {


Shouldn't we unwrap this throwable as this is coming from reactor?

.../src/main/java/com/azure/cosmos/implementation/throughputControl/ThroughputControlStore.java

...com/azure/cosmos/implementation/throughputControl/config/ThroughputControlGroupInternal.java

...azure/cosmos/implementation/throughputControl/ContainerThroughputControlGroupProperties.java

...os/implementation/throughputControl/exceptions/ThroughputControlInitializationException.java

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/ThroughputControlGroupConfigBuilder.java

...lementation/throughputControl/controller/group/global/ThroughputControlContainerManager.java

FabianMeiswinkel

LGTM except for few minor comments

…hub.com/xinlian12/azure-sdk-for-java into allowSuppressThroughputControlInitError

azure-sdk · 2022-03-21T17:22:52Z

API changes have been detected in com.azure:azure-cosmos. You can review API changes here

API changes

+         @Beta public boolean isContinueOnInitError() 
+         @Beta public ThroughputControlGroupConfigBuilder setContinueOnInitError(boolean continueOnInitError) 
-             V4_27_0;
+             V4_27_0,
+             V4_28_0;

azure-sdk · 2022-03-21T19:50:59Z

API changes have been detected in com.azure:azure-cosmos. You can review API changes here

xinlian12 · 2022-04-11T18:31:08Z

Add changeLog after the current deployment change finish, else merge conflicts for the changelog

kushagraThapar

Thanks @xinlian12 - looks great to me.

azure-sdk · 2022-04-11T18:33:28Z

API change check for com.azure:azure-cosmos

API changes have been detected in com.azure:azure-cosmos. You can review API changes here

xinlian12 · 2022-04-15T00:21:33Z

/azp run java - cosmos - tests

azure-pipelines · 2022-04-15T00:21:47Z

Azure Pipelines successfully started running 1 pipeline(s).

annie-mac added 3 commits March 15, 2022 18:36

allow request to continue on init error

7eef779

refactor

bc12796

Merge branch 'main' into allowSuppressThroughputControlInitError

a0b02b7

xinlian12 requested review from kushagraThapar, FabianMeiswinkel, kirankumarkolli, mbhaskar, simplynaveen20, milismsft and aayush3011 as code owners March 16, 2022 02:27

ghost added the Cosmos label Mar 16, 2022

annie-mac added 2 commits March 15, 2022 19:31

rename

eafe48a

update change log

cf69a6d

xinlian12 commented Mar 16, 2022

View reviewed changes

...azure/cosmos/implementation/throughputControl/ContainerThroughputControlGroupProperties.java Outdated Show resolved Hide resolved

xinlian12 commented Mar 16, 2022

View reviewed changes

.../src/main/java/com/azure/cosmos/implementation/throughputControl/ThroughputControlStore.java Outdated Show resolved Hide resolved

annie-mac added 2 commits March 15, 2022 19:44

refactor

0a8e4ba

resolve comments

67f0f90

fix tests

24dfff2

kushagraThapar reviewed Mar 17, 2022

View reviewed changes

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/ThroughputControlGroupConfigBuilder.java Outdated Show resolved Hide resolved

Update ContainerThroughputControlGroupProperties.java

61b35e8

FabianMeiswinkel reviewed Mar 17, 2022

View reviewed changes

...lementation/throughputControl/controller/group/global/ThroughputControlContainerManager.java Show resolved Hide resolved

FabianMeiswinkel approved these changes Mar 17, 2022

View reviewed changes

annie-mac added 3 commits March 21, 2022 09:02

merge master and resolve conflicts

7bb7377

Merge branch 'allowSuppressThroughputControlInitError' of https://git…

e6216df

…hub.com/xinlian12/azure-sdk-for-java into allowSuppressThroughputControlInitError

resolve comments

457d953

annie-mac added 3 commits March 21, 2022 10:33

fix spotbug

87fe3ac

resolve comments

97a4e87

update changelog

767a0b2

annie-mac and others added 4 commits March 21, 2022 13:43

fix

6288152

resolve comments

dccd67a

merge and resolve conflicts

204acd1

update the throughput control usage in spark to latest version

83b667e

kushagraThapar approved these changes Apr 11, 2022

View reviewed changes

annie-mac added 6 commits April 11, 2022 23:11

Merge branch 'main' into allowSuppressThroughputControlInitError

0e72277

Merge branch 'main' into allowSuppressThroughputControlInitError

0302871

update changelog

fdd4563

remove space

5420082

Merge branch 'main' into allowSuppressThroughputControlInitError

a665b5f

change test group

ec339b5

xinlian12 merged commit 2dab32d into Azure:main Apr 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AllowRequestContinueForThroughputControlInitError #27702

AllowRequestContinueForThroughputControlInitError #27702

xinlian12 commented Mar 16, 2022 •

edited

Loading

azure-sdk commented Mar 16, 2022

azure-sdk commented Mar 16, 2022

check-enforcer bot commented Mar 16, 2022

kushagraThapar Mar 17, 2022

FabianMeiswinkel left a comment

azure-sdk commented Mar 21, 2022

azure-sdk commented Mar 21, 2022

xinlian12 commented Apr 11, 2022

kushagraThapar left a comment

azure-sdk commented Apr 11, 2022

xinlian12 commented Apr 15, 2022

azure-pipelines bot commented Apr 15, 2022

AllowRequestContinueForThroughputControlInitError #27702

AllowRequestContinueForThroughputControlInitError #27702

Conversation

xinlian12 commented Mar 16, 2022 • edited Loading

Description

All SDK Contribution checklist:

General Guidelines and Best Practices

Testing Guidelines

azure-sdk commented Mar 16, 2022

azure-sdk commented Mar 16, 2022

check-enforcer bot commented Mar 16, 2022

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

kushagraThapar Mar 17, 2022

Choose a reason for hiding this comment

FabianMeiswinkel left a comment

Choose a reason for hiding this comment

azure-sdk commented Mar 21, 2022

azure-sdk commented Mar 21, 2022

xinlian12 commented Apr 11, 2022

kushagraThapar left a comment

Choose a reason for hiding this comment

azure-sdk commented Apr 11, 2022

xinlian12 commented Apr 15, 2022

azure-pipelines bot commented Apr 15, 2022

xinlian12 commented Mar 16, 2022 •

edited

Loading