001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.regionserver;
019
020import static org.junit.jupiter.api.Assertions.assertEquals;
021import static org.junit.jupiter.api.Assertions.assertFalse;
022import static org.junit.jupiter.api.Assertions.assertTrue;
023
024import java.util.Optional;
025import org.apache.hadoop.conf.Configuration;
026import org.apache.hadoop.hbase.TableName;
027import org.apache.hadoop.hbase.metrics.Metric;
028import org.apache.hadoop.hbase.metrics.MetricRegistries;
029import org.apache.hadoop.hbase.metrics.MetricRegistry;
030import org.apache.hadoop.hbase.metrics.MetricRegistryInfo;
031import org.apache.hadoop.hbase.metrics.Snapshot;
032import org.apache.hadoop.hbase.metrics.impl.DropwizardMeter;
033import org.apache.hadoop.hbase.metrics.impl.HistogramImpl;
034import org.apache.hadoop.hbase.regionserver.metrics.MetricsTableRequests;
035import org.apache.hadoop.hbase.testclassification.RegionServerTests;
036import org.apache.hadoop.hbase.testclassification.SmallTests;
037import org.junit.jupiter.api.AfterEach;
038import org.junit.jupiter.api.Tag;
039import org.junit.jupiter.api.Test;
040
041@Tag(RegionServerTests.TAG)
042@Tag(SmallTests.TAG)
043public class TestMetricsTableRequests {
044
045  @AfterEach
046  public void tearDown() {
047    MetricRegistries.global().clear();
048  }
049
050  @Test
051  public void testMetricsTableLatencies() {
052    TableName tn1 = TableName.valueOf("table1");
053    TableName tn2 = TableName.valueOf("table2");
054    MetricsTableRequests requests1 = new MetricsTableRequests(tn1, new Configuration());
055    MetricsTableRequests requests2 = new MetricsTableRequests(tn2, new Configuration());
056    assertTrue(requests1 instanceof MetricsTableRequests,
057      "'requests' is actually " + requests1.getClass());
058    assertTrue(requests2 instanceof MetricsTableRequests,
059      "'requests' is actually " + requests2.getClass());
060
061    MetricRegistryInfo info1 = requests1.getMetricRegistryInfo();
062    MetricRegistryInfo info2 = requests2.getMetricRegistryInfo();
063    Optional<MetricRegistry> registry1 = MetricRegistries.global().get(info1);
064    assertTrue(registry1.isPresent());
065    Optional<MetricRegistry> registry2 = MetricRegistries.global().get(info2);
066    assertTrue(registry2.isPresent());
067
068    requests1.updateGet(500L, 5000L);
069    Snapshot latencies1SnapshotGet =
070      ((HistogramImpl) registry1.get().get("getTime").get()).snapshot();
071    assertEquals(500, latencies1SnapshotGet.get999thPercentile());
072    Snapshot blockBytesScanned1SnapshotGet =
073      ((HistogramImpl) registry1.get().get("getBlockBytesScanned").get()).snapshot();
074    assertEquals(5000, blockBytesScanned1SnapshotGet.get999thPercentile());
075
076    requests1.updatePut(50L);
077    Snapshot latencies1SnapshotPut =
078      ((HistogramImpl) registry1.get().get("putTime").get()).snapshot();
079    assertEquals(50, latencies1SnapshotPut.get99thPercentile());
080
081    requests2.updateGet(300L, 3000L);
082    Snapshot latencies2SnapshotGet =
083      ((HistogramImpl) registry2.get().get("getTime").get()).snapshot();
084    assertEquals(300, latencies2SnapshotGet.get999thPercentile());
085    Snapshot blockBytesScanned2SnapshotGet =
086      ((HistogramImpl) registry2.get().get("getBlockBytesScanned").get()).snapshot();
087    assertEquals(3000, blockBytesScanned2SnapshotGet.get999thPercentile());
088
089    requests2.updatePut(75L);
090    Snapshot latencies2SnapshotPut =
091      ((HistogramImpl) registry2.get().get("putTime").get()).snapshot();
092    assertEquals(75, latencies2SnapshotPut.get99thPercentile());
093  }
094
095  @Test
096  public void testTableQueryMeterSwitch() {
097    TableName tn1 = TableName.valueOf("table1");
098    Configuration conf = new Configuration();
099    boolean enableTableQueryMeter =
100      conf.getBoolean(MetricsTableRequests.ENABLE_TABLE_QUERY_METER_METRICS_KEY,
101        MetricsTableRequests.ENABLE_TABLE_QUERY_METER_METRICS_KEY_DEFAULT);
102    // disable
103    assertFalse(enableTableQueryMeter);
104    MetricsTableRequests requests = new MetricsTableRequests(tn1, conf);
105    assertTrue(requests instanceof MetricsTableRequests,
106      "'requests' is actually " + requests.getClass());
107
108    MetricRegistryInfo info = requests.getMetricRegistryInfo();
109    Optional<MetricRegistry> registry = MetricRegistries.global().get(info);
110    assertTrue(registry.isPresent());
111    requests.updateTableReadQueryMeter(500L);
112    Optional<Metric> read = registry.get().get("tableReadQueryPerSecond");
113    assertFalse(read.isPresent());
114
115    // enable
116    conf.setBoolean(MetricsTableRequests.ENABLE_TABLE_QUERY_METER_METRICS_KEY, true);
117    enableTableQueryMeter =
118      conf.getBoolean(MetricsTableRequests.ENABLE_TABLE_QUERY_METER_METRICS_KEY,
119        MetricsTableRequests.ENABLE_TABLE_QUERY_METER_METRICS_KEY_DEFAULT);
120    assertTrue(enableTableQueryMeter);
121    requests = new MetricsTableRequests(tn1, conf);
122    assertTrue(requests instanceof MetricsTableRequests,
123      "'requests' is actually " + requests.getClass());
124
125    info = requests.getMetricRegistryInfo();
126    registry = MetricRegistries.global().get(info);
127    assertTrue(registry.isPresent());
128    requests.updateTableReadQueryMeter(500L);
129    read = registry.get().get("tableReadQueryPerSecond");
130    assertTrue(read.isPresent());
131    assertEquals(((DropwizardMeter) read.get()).getCount(), 500);
132  }
133}