org.apache.hadoop.hbase.regionserver.MetricsRegionServer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hbase-server Show documentation
Show all versions of hbase-server Show documentation
Server functionality for HBase
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.hbase.regionserver;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.CompatibilitySingletonFactory;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.metrics.Meter;
import org.apache.hadoop.hbase.metrics.MetricRegistries;
import org.apache.hadoop.hbase.metrics.MetricRegistry;
import org.apache.hadoop.hbase.metrics.Timer;
import org.apache.yetus.audience.InterfaceAudience;
import org.apache.yetus.audience.InterfaceStability;
/**
* Maintains regionserver statistics and publishes them through the metrics interfaces. This class
* has a number of metrics variables that are publicly accessible; these variables (objects) have
* methods to update their values. Batch your updates rather than call on each instance else all
* threads will do nothing but contend trying to maintain metric counters!
*/
@InterfaceStability.Evolving
@InterfaceAudience.Private
public class MetricsRegionServer {
public static final String RS_ENABLE_TABLE_METRICS_KEY =
"hbase.regionserver.enable.table.latencies";
public static final boolean RS_ENABLE_TABLE_METRICS_DEFAULT = true;
public static final String RS_ENABLE_SERVER_QUERY_METER_METRICS_KEY =
"hbase.regionserver.enable.server.query.meter";
public static final boolean RS_ENABLE_SERVER_QUERY_METER_METRICS_KEY_DEFAULT = true;
public static final String RS_ENABLE_TABLE_QUERY_METER_METRICS_KEY =
"hbase.regionserver.enable.table.query.meter";
public static final boolean RS_ENABLE_TABLE_QUERY_METER_METRICS_KEY_DEFAULT = true;
public static final String SLOW_METRIC_TIME = "hbase.ipc.slow.metric.time";
private final MetricsRegionServerSource serverSource;
private final MetricsRegionServerWrapper regionServerWrapper;
private RegionServerTableMetrics tableMetrics;
private final MetricsTable metricsTable;
private final MetricsUserAggregate userAggregate;
private MetricsRegionServerQuotaSource quotaSource;
private MetricRegistry metricRegistry;
private Timer bulkLoadTimer;
// Incremented once for each call to Scan#nextRaw
private Meter serverReadQueryMeter;
// Incremented per write.
private Meter serverWriteQueryMeter;
protected long slowMetricTime;
protected static final int DEFAULT_SLOW_METRIC_TIME = 1000; // milliseconds
public MetricsRegionServer(MetricsRegionServerWrapper regionServerWrapper, Configuration conf,
MetricsTable metricsTable) {
this(regionServerWrapper,
CompatibilitySingletonFactory.getInstance(MetricsRegionServerSourceFactory.class)
.createServer(regionServerWrapper),
createTableMetrics(conf), metricsTable,
MetricsUserAggregateFactory.getMetricsUserAggregate(conf));
// Create hbase-metrics module based metrics. The registry should already be registered by the
// MetricsRegionServerSource
metricRegistry = MetricRegistries.global().get(serverSource.getMetricRegistryInfo()).get();
// create and use metrics from the new hbase-metrics based registry.
bulkLoadTimer = metricRegistry.timer("Bulkload");
slowMetricTime = conf.getLong(SLOW_METRIC_TIME, DEFAULT_SLOW_METRIC_TIME);
quotaSource = CompatibilitySingletonFactory.getInstance(MetricsRegionServerQuotaSource.class);
if (
conf.getBoolean(RS_ENABLE_SERVER_QUERY_METER_METRICS_KEY,
RS_ENABLE_SERVER_QUERY_METER_METRICS_KEY_DEFAULT)
) {
serverReadQueryMeter = metricRegistry.meter("ServerReadQueryPerSecond");
serverWriteQueryMeter = metricRegistry.meter("ServerWriteQueryPerSecond");
}
}
MetricsRegionServer(MetricsRegionServerWrapper regionServerWrapper,
MetricsRegionServerSource serverSource, RegionServerTableMetrics tableMetrics,
MetricsTable metricsTable, MetricsUserAggregate userAggregate) {
this.regionServerWrapper = regionServerWrapper;
this.serverSource = serverSource;
this.tableMetrics = tableMetrics;
this.metricsTable = metricsTable;
this.userAggregate = userAggregate;
}
/**
* Creates an instance of {@link RegionServerTableMetrics} only if the feature is enabled.
*/
static RegionServerTableMetrics createTableMetrics(Configuration conf) {
if (conf.getBoolean(RS_ENABLE_TABLE_METRICS_KEY, RS_ENABLE_TABLE_METRICS_DEFAULT)) {
return new RegionServerTableMetrics(conf.getBoolean(RS_ENABLE_TABLE_QUERY_METER_METRICS_KEY,
RS_ENABLE_TABLE_QUERY_METER_METRICS_KEY_DEFAULT));
}
return null;
}
public MetricsRegionServerSource getMetricsSource() {
return serverSource;
}
public MetricsUserAggregate getMetricsUserAggregate() {
return userAggregate;
}
public MetricsRegionServerWrapper getRegionServerWrapper() {
return regionServerWrapper;
}
public void updatePutBatch(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updatePutBatch(tn, t);
}
serverSource.updatePutBatch(t);
}
public void updatePut(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updatePut(tn, t);
}
if (t > slowMetricTime) {
serverSource.incrSlowPut();
}
serverSource.updatePut(t);
userAggregate.updatePut(t);
}
public void updateDelete(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateDelete(tn, t);
}
if (t > slowMetricTime) {
serverSource.incrSlowDelete();
}
serverSource.updateDelete(t);
userAggregate.updateDelete(t);
}
public void updateDeleteBatch(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateDeleteBatch(tn, t);
}
serverSource.updateDeleteBatch(t);
}
public void updateCheckAndDelete(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateCheckAndDelete(tn, t);
}
serverSource.updateCheckAndDelete(t);
}
public void updateCheckAndPut(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateCheckAndPut(tn, t);
}
serverSource.updateCheckAndPut(t);
}
public void updateCheckAndMutate(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateCheckAndMutate(tn, t);
}
serverSource.updateCheckAndMutate(t);
}
public void updateGet(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateGet(tn, t);
}
if (t > slowMetricTime) {
serverSource.incrSlowGet();
}
serverSource.updateGet(t);
userAggregate.updateGet(t);
}
public void updateIncrement(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateIncrement(tn, t);
}
if (t > slowMetricTime) {
serverSource.incrSlowIncrement();
}
serverSource.updateIncrement(t);
userAggregate.updateIncrement(t);
}
public void updateAppend(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateAppend(tn, t);
}
if (t > slowMetricTime) {
serverSource.incrSlowAppend();
}
serverSource.updateAppend(t);
userAggregate.updateAppend(t);
}
public void updateReplay(long t) {
serverSource.updateReplay(t);
userAggregate.updateReplay(t);
}
public void updateScanSize(TableName tn, long scanSize) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateScanSize(tn, scanSize);
}
serverSource.updateScanSize(scanSize);
}
public void updateScanTime(TableName tn, long t) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateScanTime(tn, t);
}
serverSource.updateScanTime(t);
userAggregate.updateScanTime(t);
}
public void updateSplitTime(long t) {
serverSource.updateSplitTime(t);
}
public void incrSplitRequest() {
serverSource.incrSplitRequest();
}
public void incrSplitSuccess() {
serverSource.incrSplitSuccess();
}
public void updateFlush(String table, long t, long memstoreSize, long fileSize) {
serverSource.updateFlushTime(t);
serverSource.updateFlushMemStoreSize(memstoreSize);
serverSource.updateFlushOutputSize(fileSize);
if (table != null) {
metricsTable.updateFlushTime(table, t);
metricsTable.updateFlushMemstoreSize(table, memstoreSize);
metricsTable.updateFlushOutputSize(table, fileSize);
}
}
public void updateCompaction(String table, boolean isMajor, long t, int inputFileCount,
int outputFileCount, long inputBytes, long outputBytes) {
serverSource.updateCompactionTime(isMajor, t);
serverSource.updateCompactionInputFileCount(isMajor, inputFileCount);
serverSource.updateCompactionOutputFileCount(isMajor, outputFileCount);
serverSource.updateCompactionInputSize(isMajor, inputBytes);
serverSource.updateCompactionOutputSize(isMajor, outputBytes);
if (table != null) {
metricsTable.updateCompactionTime(table, isMajor, t);
metricsTable.updateCompactionInputFileCount(table, isMajor, inputFileCount);
metricsTable.updateCompactionOutputFileCount(table, isMajor, outputFileCount);
metricsTable.updateCompactionInputSize(table, isMajor, inputBytes);
metricsTable.updateCompactionOutputSize(table, isMajor, outputBytes);
}
}
public void updateBulkLoad(long millis) {
this.bulkLoadTimer.updateMillis(millis);
}
public void updateReadQueryMeter(TableName tn, long count) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateTableReadQueryMeter(tn, count);
}
if (serverReadQueryMeter != null) {
serverReadQueryMeter.mark(count);
}
}
public void updateWriteQueryMeter(TableName tn, long count) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateTableWriteQueryMeter(tn, count);
}
if (serverWriteQueryMeter != null) {
serverWriteQueryMeter.mark(count);
}
}
public void updateWriteQueryMeter(TableName tn) {
if (tableMetrics != null && tn != null) {
tableMetrics.updateTableWriteQueryMeter(tn);
}
if (serverWriteQueryMeter != null) {
serverWriteQueryMeter.mark();
}
}
/**
* @see MetricsRegionServerQuotaSource#incrementNumRegionSizeReportsSent(long)
*/
public void incrementNumRegionSizeReportsSent(long numReportsSent) {
quotaSource.incrementNumRegionSizeReportsSent(numReportsSent);
}
/**
* @see MetricsRegionServerQuotaSource#incrementRegionSizeReportingChoreTime(long)
*/
public void incrementRegionSizeReportingChoreTime(long time) {
quotaSource.incrementRegionSizeReportingChoreTime(time);
}
}