1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to you under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.hadoop.hbase.regionserver;
18
19 import org.apache.hadoop.hbase.metrics.BaseSource;
20
21 /**
22 * A collection of exposed metrics for space quotas from an HBase RegionServer.
23 */
24 public interface MetricsRegionServerQuotaSource extends BaseSource {
25
26 String METRICS_NAME = "Quotas";
27 String METRICS_CONTEXT = "regionserver";
28 String METRICS_DESCRIPTION = "Metrics about HBase RegionServer Quotas";
29 String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;
30
31 /**
32 * Updates the metric tracking how many tables this RegionServer has marked as in violation
33 * of their space quota.
34 */
35 void updateNumTablesInSpaceQuotaViolation(long tablesInViolation);
36
37 /**
38 * Updates the metric tracking how many tables this RegionServer has received
39 * {@code SpaceQuotaSnapshot}s for.
40 *
41 * @param numSnapshots The number of {@code SpaceQuotaSnapshot}s received from the Master.
42 */
43 void updateNumTableSpaceQuotaSnapshots(long numSnapshots);
44
45 /**
46 * Updates the metric tracking how much time was spent scanning the filesystem to compute
47 * the size of each region hosted by this RegionServer.
48 *
49 * @param time The execution time of the chore in milliseconds.
50 */
51 void incrementSpaceQuotaFileSystemScannerChoreTime(long time);
52
53 /**
54 * Updates the metric tracking how much time was spent updating the RegionServer with the
55 * latest information on space quotas from the {@code hbase:quota} table.
56 *
57 * @param time The execution time of the chore in milliseconds.
58 */
59 void incrementSpaceQuotaRefresherChoreTime(long time);
60 }