hbase-server/src/main/java/org/apache/hadoop/hbase/master/MetricsMaster.java

   1 /**
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 package org.apache.hadoop.hbase.master;
  20
  21 import org.apache.commons.logging.Log;
  22 import org.apache.commons.logging.LogFactory;
  23 import org.apache.hadoop.hbase.classification.InterfaceAudience;
  24 import org.apache.hadoop.hbase.classification.InterfaceStability;
  25 import org.apache.hadoop.hbase.CompatibilitySingletonFactory;
  26 import org.apache.hadoop.hbase.metrics.Counter;
  27 import org.apache.hadoop.hbase.metrics.Histogram;
  28 import org.apache.hadoop.hbase.metrics.OperationMetrics;
  29 import org.apache.hadoop.hbase.procedure2.ProcedureMetrics;
  30
  31 /**
  32  * This class is for maintaining the various master statistics
  33  * and publishing them through the metrics interfaces.
  34  * <p>
  35  * This class has a number of metrics variables that are publicly accessible;
  36  * these variables (objects) have methods to update their values.
  37  */
  38 @InterfaceStability.Evolving
  39 @InterfaceAudience.Private
  40 public class MetricsMaster {
  41   private static final Log LOG = LogFactory.getLog(MetricsMaster.class);
  42   private MetricsMasterSource masterSource;
  43   private MetricsMasterProcSource masterProcSource;
  44   private MetricsMasterQuotaSource masterQuotaSource;
  45
  46   private ProcedureMetrics serverCrashProcMetrics;
  47
  48   public MetricsMaster(MetricsMasterWrapper masterWrapper) {
  49     masterSource = CompatibilitySingletonFactory.getInstance(MetricsMasterSourceFactory.class).create(masterWrapper);
  50     masterProcSource =
  51             CompatibilitySingletonFactory.getInstance(MetricsMasterProcSourceFactory.class).create(masterWrapper);
  52     masterQuotaSource =
  53             CompatibilitySingletonFactory.getInstance(MetricsMasterQuotaSourceFactory.class).create(masterWrapper);
  54
  55     serverCrashProcMetrics = convertToProcedureMetrics(masterSource.getServerCrashMetrics());
  56   }
  57
  58   // for unit-test usage
  59   public MetricsMasterSource getMetricsSource() {
  60     return masterSource;
  61   }
  62
  63   public MetricsMasterProcSource getMetricsProcSource() {
  64     return masterProcSource;
  65   }
  66
  67   public MetricsMasterQuotaSource getMetricsQuotaSource() {
  68     return masterQuotaSource;
  69   }
  70
  71   /**
  72    * @param inc How much to add to requests.
  73    */
  74   public void incrementRequests(final long inc) {
  75     masterSource.incRequests(inc);
  76   }
  77
  78   /**
  79    * Sets the number of space quotas defined.
  80    *
  81    * @see MetricsMasterQuotaSource#updateNumSpaceQuotas(long)
  82    */
  83   public void setNumSpaceQuotas(final long numSpaceQuotas) {
  84     masterQuotaSource.updateNumSpaceQuotas(numSpaceQuotas);
  85   }
  86
  87   /**
  88    * Sets the number of table in violation of a space quota.
  89    *
  90    * @see MetricsMasterQuotaSource#updateNumTablesInSpaceQuotaViolation(long)
  91    */
  92   public void setNumTableInSpaceQuotaViolation(final long numTablesInViolation) {
  93     masterQuotaSource.updateNumTablesInSpaceQuotaViolation(numTablesInViolation);
  94   }
  95
  96   /**
  97    * Sets the number of namespaces in violation of a space quota.
  98    *
  99    * @see MetricsMasterQuotaSource#updateNumNamespacesInSpaceQuotaViolation(long)
 100    */
 101   public void setNumNamespacesInSpaceQuotaViolation(final long numNamespacesInViolation) {
 102     masterQuotaSource.updateNumNamespacesInSpaceQuotaViolation(numNamespacesInViolation);
 103   }
 104
 105   /**
 106    * Sets the number of region size reports the master currently has in memory.
 107    *
 108    * @see MetricsMasterQuotaSource#updateNumCurrentSpaceQuotaRegionSizeReports(long)
 109    */
 110   public void setNumRegionSizeReports(final long numRegionReports) {
 111     masterQuotaSource.updateNumCurrentSpaceQuotaRegionSizeReports(numRegionReports);
 112   }
 113
 114   /**
 115    * Sets the execution time of a period of the QuotaObserverChore.
 116    *
 117    * @param executionTime The execution time in milliseconds.
 118    * @see MetricsMasterQuotaSource#incrementSpaceQuotaObserverChoreTime(long)
 119    */
 120   public void incrementQuotaObserverTime(final long executionTime) {
 121     masterQuotaSource.incrementSpaceQuotaObserverChoreTime(executionTime);
 122   }
 123
 124   /**
 125    * @return Set of metrics for assign procedure
 126    */
 127   public ProcedureMetrics getServerCrashProcMetrics() {
 128     return serverCrashProcMetrics;
 129   }
 130
 131   /**
 132    * This is utility function that converts {@link OperationMetrics} to {@link ProcedureMetrics}.
 133    *
 134    * NOTE: Procedure framework in hbase-procedure module accesses metrics common to most procedures
 135    * through {@link ProcedureMetrics} interface. Metrics source classes in hbase-hadoop-compat
 136    * module provides similar interface {@link OperationMetrics} that contains metrics common to
 137    * most operations. As both hbase-procedure and hbase-hadoop-compat are lower level modules used
 138    * by hbase-server (this) module and there is no dependency between them, this method does the
 139    * required conversion.
 140    */
 141   public static ProcedureMetrics convertToProcedureMetrics(final OperationMetrics metrics) {
 142     return new ProcedureMetrics() {
 143       @Override
 144       public Counter getSubmittedCounter() {
 145         return metrics.getSubmittedCounter();
 146       }
 147
 148       @Override
 149       public Histogram getTimeHisto() {
 150         return metrics.getTimeHisto();
 151       }
 152
 153       @Override
 154       public Counter getFailedCounter() {
 155         return metrics.getFailedCounter();
 156       }
 157     };
 158   }
 159
 160   /**
 161    * Sets the execution time of a period of the {@code SnapshotQuotaObserverChore}.
 162    */
 163   public void incrementSnapshotObserverTime(final long executionTime) {
 164     masterQuotaSource.incrementSnapshotObserverChoreTime(executionTime);
 165   }
 166
 167   /**
 168    * Sets the execution time to compute the size of a single snapshot.
 169    */
 170   public void incrementSnapshotSizeComputationTime(final long executionTime) {
 171     masterQuotaSource.incrementSnapshotObserverSnapshotComputationTime(executionTime);
 172   }
 173
 174   /**
 175    * Sets the execution time to fetch the mapping of snapshots to originating table.
 176    */
 177   public void incrementSnapshotFetchTime(long executionTime) {
 178     masterQuotaSource.incrementSnapshotObserverSnapshotFetchTime(executionTime);
 179   }
 180 }