Skip to content

HBASE-28123 TableRequests metrics broken after altering table #7855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
liuxiaocs7 wants to merge 1 commit into
base: master
Choose a base branch
from
+254 −73
Open

HBASE-28123 TableRequests metrics broken after altering table #7855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions ...pat/src/main/java/org/apache/hadoop/hbase/metrics/impl/GlobalMetricRegistriesAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,17 @@ public final class GlobalMetricRegistriesAdapter {
private static final Logger LOG = LoggerFactory.getLogger(GlobalMetricRegistriesAdapter.class);

private class MetricsSourceAdapter implements MetricsSource {
private final MetricRegistry registry;
private final MetricRegistryInfo info;

MetricsSourceAdapter(MetricRegistry registry) {
this.registry = registry;
MetricsSourceAdapter(MetricRegistryInfo info) {
this.info = info;
}

@Override
public void getMetrics(MetricsCollector collector, boolean all) {
metricsAdapter.snapshotAllMetrics(registry, collector);
Optional<MetricRegistry> registryOpt = MetricRegistries.global().get(info);
registryOpt
.ifPresent(metricRegistry -> metricsAdapter.snapshotAllMetrics(metricRegistry, collector));
Comment on lines 65 to +76
Copy link
Contributor Author

@liuxiaocs7 liuxiaocs7 Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the fix

}
}

Expand Down Expand Up @@ -115,7 +117,7 @@ private void doRun() {
for (MetricRegistry registry : registries) {
MetricRegistryInfo info = registry.getMetricRegistryInfo();

LOG.trace("MetricRegistryInfo : " + info.getMetricsName());
LOG.trace("MetricRegistryInfo : {}", info.getMetricsName());
if (info.isExistingSource()) {
// If there is an already existing BaseSource for this MetricRegistry, skip it here. These
// types of registries are there only due to existing BaseSource implementations in the
Expand All @@ -128,10 +130,10 @@ private void doRun() {

if (!registeredSources.containsKey(info)) {
if (LOG.isDebugEnabled()) {
LOG.debug("Registering adapter for the MetricRegistry: " + info.getMetricsJmxContext());
LOG.debug("Registering adapter for the MetricRegistry: {}", info.getMetricsJmxContext());
}
// register this as a MetricSource under different JMX Context'es.
MetricsSourceAdapter adapter = new MetricsSourceAdapter(registry);
MetricsSourceAdapter adapter = new MetricsSourceAdapter(info);
LOG.info("Registering " + info.getMetricsJmxContext() + " " + info.getMetricsDescription());
DefaultMetricsSystem.instance().register(info.getMetricsJmxContext(),
info.getMetricsDescription(), adapter);
Expand All @@ -148,9 +150,9 @@ private void doRun() {
Entry<MetricRegistryInfo, MetricsSourceAdapter> entry = it.next();
MetricRegistryInfo info = entry.getKey();
Optional<MetricRegistry> found = MetricRegistries.global().get(info);
if (!found.isPresent()) {
if (found.isEmpty()) {
if (LOG.isDebugEnabled()) {
LOG.debug("Removing adapter for the MetricRegistry: " + info.getMetricsJmxContext());
LOG.debug("Removing adapter for the MetricRegistry: {}", info.getMetricsJmxContext());
}
synchronized (DefaultMetricsSystem.instance()) {
DefaultMetricsSystem.instance().unregisterSource(info.getMetricsJmxContext());
Expand Down
9 changes: 0 additions & 9 deletions hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,15 +287,6 @@ public void updateWriteQueryMeter(HRegion region, long count) {
}
}

public void updateWriteQueryMeter(HRegion region) {
if (region.getMetricsTableRequests() != null) {
region.getMetricsTableRequests().updateTableWriteQueryMeter();
}
if (serverWriteQueryMeter != null) {
serverWriteQueryMeter.mark();
}
}

public void incrScannerLeaseExpired() {
serverSource.incrScannerLeaseExpired();
}
Expand Down
46 changes: 18 additions & 28 deletions ...rver/src/main/java/org/apache/hadoop/hbase/regionserver/metrics/MetricsTableRequests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
*/
package org.apache.hadoop.hbase.regionserver.metrics;

import com.google.errorprone.annotations.RestrictedApi;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.metrics.Counter;
Expand Down Expand Up @@ -110,14 +111,14 @@ public class MetricsTableRequests {
private MetricRegistryInfo registryInfo;

private boolean enableTableLatenciesMetrics;
private boolean enabTableQueryMeterMetrics;
private boolean enableTableQueryMeterMetrics;

public boolean isEnableTableLatenciesMetrics() {
return enableTableLatenciesMetrics;
}

public boolean isEnabTableQueryMeterMetrics() {
return enabTableQueryMeterMetrics;
public boolean isEnableTableQueryMeterMetrics() {
return enableTableQueryMeterMetrics;
}

public MetricsTableRequests(TableName tableName, Configuration conf) {
Expand All @@ -129,9 +130,9 @@ private void init(TableName tableName, Configuration conf) {
this.conf = conf;
enableTableLatenciesMetrics = this.conf.getBoolean(ENABLE_TABLE_LATENCIES_METRICS_KEY,
ENABLE_TABLE_LATENCIES_METRICS_DEFAULT);
enabTableQueryMeterMetrics = this.conf.getBoolean(ENABLE_TABLE_QUERY_METER_METRICS_KEY,
enableTableQueryMeterMetrics = this.conf.getBoolean(ENABLE_TABLE_QUERY_METER_METRICS_KEY,
ENABLE_TABLE_QUERY_METER_METRICS_KEY_DEFAULT);
if (enableTableLatenciesMetrics || enabTableQueryMeterMetrics) {
if (enableTableLatenciesMetrics || enableTableQueryMeterMetrics) {
registry = createRegistryForTableRequests();
if (enableTableLatenciesMetrics) {
getTimeHistogram = registry.histogram(GET_TIME);
Expand All @@ -155,7 +156,7 @@ private void init(TableName tableName, Configuration conf) {
scanBlockBytesScanned = registry.histogram(SCAN_BLOCK_BYTES_SCANNED_KEY);
}

if (enabTableQueryMeterMetrics) {
if (enableTableQueryMeterMetrics) {
readMeter = registry.meter(TABLE_READ_QUERY_PER_SECOND);
writeMeter = registry.meter(TABLE_WRITE_QUERY_PER_SECOND);
}
Expand All @@ -173,7 +174,7 @@ private MetricRegistryInfo createRegistryInfoForTableRequests() {
}

public void removeRegistry() {
if (enableTableLatenciesMetrics || enabTableQueryMeterMetrics) {
if (enableTableLatenciesMetrics || enableTableQueryMeterMetrics) {
MetricRegistries.global().remove(registry.getMetricRegistryInfo());
}
}
Expand Down Expand Up @@ -327,41 +328,30 @@ public void updateCheckAndMutate(long time, long blockBytesScanned) {
* @param count Number of occurrences to record
*/
public void updateTableReadQueryMeter(long count) {
if (isEnabTableQueryMeterMetrics()) {
if (isEnableTableQueryMeterMetrics()) {
readMeter.mark(count);
}
}

/**
* Update table read QPS
*/
public void updateTableReadQueryMeter() {
if (isEnabTableQueryMeterMetrics()) {
readMeter.mark();
}
}

/**
* Update table write QPS
* @param count Number of occurrences to record
*/
public void updateTableWriteQueryMeter(long count) {
if (isEnabTableQueryMeterMetrics()) {
if (isEnableTableQueryMeterMetrics()) {
writeMeter.mark(count);
}
}

/**
* Update table write QPS
*/
public void updateTableWriteQueryMeter() {
if (isEnabTableQueryMeterMetrics()) {
writeMeter.mark();
}
}

// Visible for testing
@RestrictedApi(explanation = "Should only be called in TestMetricsTableRequests", link = "",
allowedOnPath = ".*/TestMetricsTableRequests.java")
public MetricRegistryInfo getMetricRegistryInfo() {
return registryInfo;
}

@RestrictedApi(explanation = "Should only be called in TestMetricsTableRequests", link = "",
allowedOnPath = ".*/TestMetricsTableRequests.java")
public MetricRegistry getMetricRegistry() {
return registry;
}
}
4 changes: 2 additions & 2 deletions hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/TestMetricsRegionServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ public void testSlowCount() {
MetricsTableRequests metricsTableRequests = mock(MetricsTableRequests.class);
when(region.getMetricsTableRequests()).thenReturn(metricsTableRequests);
when(metricsTableRequests.isEnableTableLatenciesMetrics()).thenReturn(false);
when(metricsTableRequests.isEnabTableQueryMeterMetrics()).thenReturn(false);
when(metricsTableRequests.isEnableTableQueryMeterMetrics()).thenReturn(false);
for (int i = 0; i < 12; i++) {
rsm.updateAppend(region, 12, 120);
rsm.updateAppend(region, 1002, 10020);
Expand Down Expand Up @@ -311,7 +311,7 @@ public void testTableQueryMeterSwitch() {
MetricsTableRequests metricsTableRequests = mock(MetricsTableRequests.class);
when(region.getMetricsTableRequests()).thenReturn(metricsTableRequests);
when(metricsTableRequests.isEnableTableLatenciesMetrics()).thenReturn(false);
when(metricsTableRequests.isEnabTableQueryMeterMetrics()).thenReturn(false);
when(metricsTableRequests.isEnableTableQueryMeterMetrics()).thenReturn(false);
Configuration conf = new Configuration(false);
// disable
rsm.updateReadQueryMeter(region, 500L);
Expand Down
4 changes: 2 additions & 2 deletions ...e-server/src/test/java/org/apache/hadoop/hbase/regionserver/TestMetricsUserAggregate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ private void doOperations() {
MetricsTableRequests metricsTableRequests = mock(MetricsTableRequests.class);
when(region.getMetricsTableRequests()).thenReturn(metricsTableRequests);
when(metricsTableRequests.isEnableTableLatenciesMetrics()).thenReturn(false);
when(metricsTableRequests.isEnabTableQueryMeterMetrics()).thenReturn(false);
when(metricsTableRequests.isEnableTableQueryMeterMetrics()).thenReturn(false);
for (int i = 0; i < 10; i++) {
rsm.updateGet(region, 10, 10);
}
Expand Down Expand Up @@ -151,7 +151,7 @@ public Void run() {
MetricsTableRequests metricsTableRequests = mock(MetricsTableRequests.class);
when(region.getMetricsTableRequests()).thenReturn(metricsTableRequests);
when(metricsTableRequests.isEnableTableLatenciesMetrics()).thenReturn(false);
when(metricsTableRequests.isEnabTableQueryMeterMetrics()).thenReturn(false);
when(metricsTableRequests.isEnableTableQueryMeterMetrics()).thenReturn(false);
rsm.updateGet(region, 10, 100);
return null;
}
Expand Down
53 changes: 30 additions & 23 deletions ...egionserver/TestMetricsTableRequests.java → ...ver/metrics/TestMetricsTableRequests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,14 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.hbase.regionserver;
package org.apache.hadoop.hbase.regionserver.metrics;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.Optional;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.HBaseClassTestRule;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.metrics.Metric;
import org.apache.hadoop.hbase.metrics.MetricRegistries;
Expand All @@ -32,30 +31,22 @@
import org.apache.hadoop.hbase.metrics.Snapshot;
import org.apache.hadoop.hbase.metrics.impl.DropwizardMeter;
import org.apache.hadoop.hbase.metrics.impl.HistogramImpl;
import org.apache.hadoop.hbase.regionserver.metrics.MetricsTableRequests;
import org.apache.hadoop.hbase.testclassification.RegionServerTests;
import org.apache.hadoop.hbase.testclassification.SmallTests;
import org.junit.ClassRule;
import org.junit.Test;
import org.junit.experimental.categories.Category;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInfo;

@Category({ RegionServerTests.class, SmallTests.class })
@Tag(RegionServerTests.TAG)
@Tag(SmallTests.TAG)
public class TestMetricsTableRequests {

@ClassRule
public static final HBaseClassTestRule CLASS_RULE =
HBaseClassTestRule.forClass(TestMetricsTableRequests.class);

@Test
public void testMetricsTableLatencies() {
TableName tn1 = TableName.valueOf("table1");
TableName tn2 = TableName.valueOf("table2");
MetricsTableRequests requests1 = new MetricsTableRequests(tn1, new Configuration());
MetricsTableRequests requests2 = new MetricsTableRequests(tn2, new Configuration());
assertTrue("'requests' is actually " + requests1.getClass(),
requests1 instanceof MetricsTableRequests);
assertTrue("'requests' is actually " + requests2.getClass(),
requests2 instanceof MetricsTableRequests);

MetricRegistryInfo info1 = requests1.getMetricRegistryInfo();
MetricRegistryInfo info2 = requests2.getMetricRegistryInfo();
Expand Down Expand Up @@ -101,8 +92,6 @@ public void testTableQueryMeterSwitch() {
// disable
assertFalse(enableTableQueryMeter);
MetricsTableRequests requests = new MetricsTableRequests(tn1, conf);
assertTrue("'requests' is actually " + requests.getClass(),
requests instanceof MetricsTableRequests);

MetricRegistryInfo info = requests.getMetricRegistryInfo();
Optional<MetricRegistry> registry = MetricRegistries.global().get(info);
Expand All @@ -118,15 +107,33 @@ public void testTableQueryMeterSwitch() {
MetricsTableRequests.ENABLE_TABLE_QUERY_METER_METRICS_KEY_DEFAULT);
assertTrue(enableTableQueryMeter);
requests = new MetricsTableRequests(tn1, conf);
assertTrue("'requests' is actually " + requests.getClass(),
requests instanceof MetricsTableRequests);

info = requests.getMetricRegistryInfo();
registry = MetricRegistries.global().get(info);
assertTrue(registry.isPresent());
requests.updateTableReadQueryMeter(500L);
read = registry.get().get("tableReadQueryPerSecond");
assertTrue(read.isPresent());
assertEquals(((DropwizardMeter) read.get()).getCount(), 500);
assertEquals(500, ((DropwizardMeter) read.get()).getCount());
}

@Test
public void testSameRegistryInstanceRefCounting(TestInfo testInfo) {
TableName tn1 = TableName.valueOf(testInfo.getTestMethod().get().getName());

// create registry twice, should return same instance due to ref-counting
MetricsTableRequests requests1 = new MetricsTableRequests(tn1, new Configuration());
MetricsTableRequests requests2 = new MetricsTableRequests(tn1, new Configuration());

MetricRegistry metricRegistry1 = requests1.getMetricRegistry();
MetricRegistry metricRegistry2 = requests2.getMetricRegistry();
// verify ref-counting returns same instance
assertEquals(metricRegistry1, metricRegistry2);

MetricRegistryInfo registryInfo = metricRegistry1.getMetricRegistryInfo();
MetricRegistries.global().remove(registryInfo);
assertTrue(MetricRegistries.global().get(registryInfo).isPresent());
MetricRegistries.global().remove(registryInfo);
assertFalse(MetricRegistries.global().get(registryInfo).isPresent());
}
}
Loading
Loading