HBASE-28346: Expose checkQuota to Coprocessor Endpoints #6066

charlesconnell · 2024-07-09T18:39:39Z

This new wiring will not have any users in this PR. I want to use this in AggregateImplemention or something like it, but I will put that in a separate ticket because it might be a big change.

rmdmattingly

It might be nice to create a basic minicluster test that implements a coproc using this framework and runs into quotas as expected

rmdmattingly · 2024-07-09T19:02:20Z

...e-server/src/main/java/org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.java

+  OperationQuota checkScanQuota(Scan scan, long maxBlockBytesScanned,
+    long prevBlockBytesScannedDifference) throws IOException, RpcThrottlingException;


We'll probably want to add support for checking batch quotas as well. I guess maybe that can be done trivially via the RpcQuotaManager, but could be nice for API consistency maybe?

charlesconnell · 2024-07-10T22:29:28Z

Added a new test

ndimiduk

Looks alright by me. I just have the open question about exposing our shaded-protobufs to coprocessor users.

ndimiduk · 2024-07-17T09:23:24Z

...e-server/src/main/java/org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.java

 import org.apache.hadoop.hbase.regionserver.OnlineRegions;
 import org.apache.hadoop.hbase.regionserver.Region;
 import org.apache.yetus.audience.InterfaceAudience;
 import org.apache.yetus.audience.InterfaceStability;

+import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos;


Just to check, which protobufs are we exposing to Coprocessor implementations, is it the shaded or unshaded module? Do we have an ErrorProne check that we always do the right thing?

Or -- do we ever? Browsing through the other coprocessor interfaces and base classes, I don't see any protobufs used. Instead, it's all pure Java POJOs.

Should this be org.apache.hadoop.hbase.client.Action and that class exposed to IA.LimitedPrivate ?

Ah, but this Quota stuff is all up in the RegionServer's business, where shaded protobufs are indeed used directly.

I think the question stands, of whether we want to expose the shaded protobufs to our coprocessor APIs, or if we need to keep this as a "pure" interface.

@apurtell @Apache9 @busbey where do you stand on this question?

According to the ref guide:

In HBase 3.0.0, the hbase-protocol module has been purged, the CPEP implementation should use the protos in hbase-protocol-shaded module, and also make use of the shaded protobuf in hbase-thirdparty.

I also think I remember Andrew saying that our protos are LimitedPrivate (but cant find that in the refguid). If you look at MultiRowMutationEndpoint in branch-3, it has access to org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos

So it seems like it should be ok to expose it in master/branch-3. I think in branch-2 it might be more tricky. MultiRowMutationEndpoint only has access to unshaded protobuf there, so it wouldn't translate into the server internals which use shaded.

One option here would be to not expose checkBatchQuota with ClientProtos.Action as an argument. The implementation of that method on the server side actually just iterates the batch to count the reads and writes, then calls a different checkBatchQuota that takes those two ints. We could expose something like checkBatchQuota(region, int reads, int writes).

I'm okay with this approach, assuming that we expect downstream implementations to be okay with the lower fidelity summary of the actions list.

I've made that change.

ndimiduk · 2024-07-17T09:39:16Z

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RegionCoprocessorHost.java

@@ -131,6 +138,12 @@ public RegionEnvironment(final RegionCoprocessor impl, final int priority, final
      this.services = services;
      this.metricRegistry =
        MetricsCoprocessor.createRegistryForRegionCoprocessor(impl.getClass().getName());
+      // lets unit tests through


What does this comment mean?

made this more clear

ndimiduk · 2024-07-17T09:40:40Z

...erver/src/test/java/org/apache/hadoop/hbase/coprocessor/TestRegionCoprocessorQuotaUsage.java

+  }
+
+  public static class MyCoprocessor implements RegionCoprocessor {
+    private RegionCoprocessorEnvironment env;


ndimiduk · 2024-07-17T09:46:32Z

...erver/src/test/java/org/apache/hadoop/hbase/coprocessor/TestRegionCoprocessorQuotaUsage.java

+
+  @AfterClass
+  public static void tearDown() throws Exception {
+    CONN.close();


docstring on HBaseTestingUtil#getConnection() says,

/** * Get a shared Connection to the cluster. this method is thread safe. * @return A Connection that can be shared. Don't close. Will be closed on shutdown of cluster. */

Apache-HBase · 2024-07-25T12:47:03Z

🎊 +1 overall

Vote	Subsystem	Runtime	Logfile	Comment
+0 🆗	reexec	0m 48s		Docker mode activated.
			_ Prechecks _
+1 💚	dupname	0m 0s		No case conflicting files found.
+0 🆗	codespell	0m 0s		codespell was not available.
+0 🆗	detsecrets	0m 0s		detect-secrets was not available.
+1 💚	@author	0m 0s		The patch does not contain any @author tags.
+1 💚	hbaseanti	0m 0s		Patch does not have any anti-patterns.
			_ master Compile Tests _
+1 💚	mvninstall	4m 4s		master passed
+1 💚	compile	3m 46s		master passed
+1 💚	checkstyle	0m 49s		master passed
+1 💚	spotbugs	1m 52s		master passed
+1 💚	spotless	0m 48s		branch has no errors when running spotless:check.
			_ Patch Compile Tests _
+1 💚	mvninstall	3m 30s		the patch passed
+1 💚	compile	3m 5s		the patch passed
+1 💚	javac	3m 5s		the patch passed
+1 💚	blanks	0m 0s		The patch has no blanks issues.
+1 💚	checkstyle	0m 39s		the patch passed
+1 💚	spotbugs	2m 0s		the patch passed
+1 💚	hadoopcheck	12m 7s		Patch does not cause any errors with Hadoop 3.3.6 3.4.0.
+1 💚	spotless	0m 44s		patch has no errors when running spotless:check.
			_ Other Tests _
+1 💚	asflicense	0m 11s		The patch does not generate ASF License warnings.
		40m 51s

Subsystem	Report/Notes
Docker	ClientAPI=1.46 ServerAPI=1.46 base: https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6066/5/artifact/yetus-general-check/output/Dockerfile
GITHUB PR	#6066
JIRA Issue	HBASE-28346
Optional Tests	dupname asflicense javac spotbugs checkstyle codespell detsecrets compile hadoopcheck hbaseanti spotless
uname	Linux 4f7e6ac185cc 5.4.0-186-generic #206-Ubuntu SMP Fri Apr 26 12:31:10 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux
Build tool	maven
Personality	dev-support/hbase-personality.sh
git revision	master / `2825e30`
Default Java	Eclipse Adoptium-17.0.11+9
Max. process+thread count	84 (vs. ulimit of 30000)
modules	C: hbase-server U: hbase-server
Console output	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6066/5/console
versions	git=2.34.1 maven=3.9.8 spotbugs=4.7.3
Powered by	Apache Yetus 0.15.0 https://yetus.apache.org

This message was automatically generated.

Apache-HBase · 2024-07-25T16:42:32Z

🎊 +1 overall

Vote	Subsystem	Runtime	Logfile	Comment
+0 🆗	reexec	0m 39s		Docker mode activated.
-0 ⚠️	yetus	0m 3s		Unprocessed flag(s): --brief-report-file --spotbugs-strict-precheck --author-ignore-list --blanks-eol-ignore-file --blanks-tabs-ignore-file --quick-hadoopcheck
			_ Prechecks _
			_ master Compile Tests _
+1 💚	mvninstall	3m 53s		master passed
+1 💚	compile	1m 10s		master passed
+1 💚	javadoc	0m 35s		master passed
+1 💚	shadedjars	6m 38s		branch has no errors when building our shaded downstream artifacts.
			_ Patch Compile Tests _
+1 💚	mvninstall	3m 45s		the patch passed
+1 💚	compile	1m 6s		the patch passed
+1 💚	javac	1m 6s		the patch passed
+1 💚	javadoc	0m 32s		the patch passed
+1 💚	shadedjars	6m 27s		patch has no errors when building our shaded downstream artifacts.
			_ Other Tests _
+1 💚	unit	246m 48s		hbase-server in the patch passed.
		276m 31s

Subsystem	Report/Notes
Docker	ClientAPI=1.43 ServerAPI=1.43 base: https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6066/5/artifact/yetus-jdk17-hadoop3-check/output/Dockerfile
GITHUB PR	#6066
JIRA Issue	HBASE-28346
Optional Tests	javac javadoc unit compile shadedjars
uname	Linux 1b8e3056948b 5.4.0-1103-aws #111~18.04.1-Ubuntu SMP Tue May 23 20:04:10 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
Build tool	maven
Personality	dev-support/hbase-personality.sh
git revision	master / `2825e30`
Default Java	Eclipse Adoptium-17.0.11+9
Test Results	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6066/5/testReport/
Max. process+thread count	4437 (vs. ulimit of 30000)
modules	C: hbase-server U: hbase-server
Console output	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6066/5/console
versions	git=2.34.1 maven=3.9.8
Powered by	Apache Yetus 0.15.0 https://yetus.apache.org

This message was automatically generated.

Signed-off-by: Nick Dimiduk <[email protected]>

Signed-off-by: Nick Dimiduk <[email protected]> Co-authored-by: Charles Connell <[email protected]>

…he#6066)" This reverts commit 70619f0.

… (addendum) Add default implementations of the new methods so that a custom implementation of RegionCoprocessorEnvironment will not fail to compile after upgrade.

…ndum) (#6350) Add default implementations of the new methods so that a custom implementation of RegionCoprocessorEnvironment will not fail to compile after upgrade. Signed-off-by: Nihal Jain <[email protected]>

… (addendum) (apache#6350) Add default implementations of the new methods so that a custom implementation of RegionCoprocessorEnvironment will not fail to compile after upgrade. Signed-off-by: Nihal Jain <[email protected]>

…ndum) (#6350) Add default implementations of the new methods so that a custom implementation of RegionCoprocessorEnvironment will not fail to compile after upgrade. Signed-off-by: Nihal Jain <[email protected]>

rmdmattingly reviewed Jul 9, 2024

View reviewed changes

This comment has been minimized.

Sign in to view

ndimiduk approved these changes Jul 17, 2024

View reviewed changes

This comment has been minimized.

Sign in to view

charlesconnell added 6 commits July 25, 2024 07:46

Expose checkQuota to Coprocessor Endpoints

33f4ddf

Test new behavior, fix existing test

e24e79b

spotless

3ca3c13

different strategy for unit tests

bfbae1c

small cleanup

cbc708b

Remove references to ClientProtos

2825e30

charlesconnell force-pushed the coprocessor-env-quota branch from e27117f to 2825e30 Compare July 25, 2024 11:57

ndimiduk approved these changes Aug 6, 2024

View reviewed changes

ndimiduk merged commit 158b6d0 into apache:master Aug 6, 2024
1 check passed

ndimiduk deleted the coprocessor-env-quota branch August 6, 2024 10:47

ndimiduk pushed a commit to ndimiduk/hbase that referenced this pull request Aug 6, 2024

HBASE-28346: Expose checkQuota to Coprocessor Endpoints (apache#6066)

393bd60

Signed-off-by: Nick Dimiduk <[email protected]>

ndimiduk pushed a commit to ndimiduk/hbase that referenced this pull request Aug 6, 2024

HBASE-28346: Expose checkQuota to Coprocessor Endpoints (apache#6066)

e7beb01

Signed-off-by: Nick Dimiduk <[email protected]>

ndimiduk pushed a commit to ndimiduk/hbase that referenced this pull request Aug 6, 2024

HBASE-28346: Expose checkQuota to Coprocessor Endpoints (apache#6066)

431ecb3

Signed-off-by: Nick Dimiduk <[email protected]>

ndimiduk pushed a commit that referenced this pull request Aug 7, 2024

HBASE-28346: Expose checkQuota to Coprocessor Endpoints (#6066)

9f5b1f1

Signed-off-by: Nick Dimiduk <[email protected]>

ndimiduk added a commit that referenced this pull request Aug 7, 2024

HBASE-28346: Expose checkQuota to Coprocessor Endpoints (#6066)

f0f6131

Signed-off-by: Nick Dimiduk <[email protected]> Co-authored-by: Charles Connell <[email protected]>

ndimiduk added a commit that referenced this pull request Aug 7, 2024

HBASE-28346: Expose checkQuota to Coprocessor Endpoints (#6066)

70619f0

Signed-off-by: Nick Dimiduk <[email protected]> Co-authored-by: Charles Connell <[email protected]>

charlesconnell added a commit to HubSpot/hbase that referenced this pull request Aug 7, 2024

HBASE-28346: Expose checkQuota to Coprocessor Endpoints (apache#6066)

c6800d6

Signed-off-by: Nick Dimiduk <[email protected]> Co-authored-by: Charles Connell <[email protected]>

charlesconnell added a commit to HubSpot/hbase that referenced this pull request Aug 19, 2024

HBASE-28346: Expose checkQuota to Coprocessor Endpoints (apache#6066)

ce5013a

Signed-off-by: Nick Dimiduk <[email protected]> Co-authored-by: Charles Connell <[email protected]>

ndimiduk added a commit to ndimiduk/hbase that referenced this pull request Oct 4, 2024

Revert "HBASE-28346: Expose checkQuota to Coprocessor Endpoints (apac…

b7221c2

…he#6066)" This reverts commit 70619f0.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HBASE-28346: Expose checkQuota to Coprocessor Endpoints #6066

HBASE-28346: Expose checkQuota to Coprocessor Endpoints #6066

charlesconnell commented Jul 9, 2024

rmdmattingly left a comment

rmdmattingly Jul 9, 2024

charlesconnell Jul 10, 2024

This comment has been minimized.

This comment has been minimized.

charlesconnell commented Jul 10, 2024

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ndimiduk left a comment

ndimiduk Jul 17, 2024

ndimiduk Jul 17, 2024

ndimiduk Jul 17, 2024

bbeaudreault Jul 18, 2024

ndimiduk Jul 24, 2024

charlesconnell Jul 25, 2024

ndimiduk Jul 17, 2024

charlesconnell Jul 17, 2024

ndimiduk Jul 17, 2024

charlesconnell Jul 17, 2024

ndimiduk Jul 17, 2024

This comment has been minimized.

This comment has been minimized.

Apache-HBase commented Jul 25, 2024

Apache-HBase commented Jul 25, 2024

		OperationQuota checkScanQuota(Scan scan, long maxBlockBytesScanned,
		long prevBlockBytesScannedDifference) throws IOException, RpcThrottlingException;

HBASE-28346: Expose checkQuota to Coprocessor Endpoints #6066

HBASE-28346: Expose checkQuota to Coprocessor Endpoints #6066

Conversation

charlesconnell commented Jul 9, 2024

rmdmattingly left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

charlesconnell commented Jul 10, 2024

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ndimiduk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

Apache-HBase commented Jul 25, 2024

Apache-HBase commented Jul 25, 2024