hbase-client/src/main/java/org/apache/hadoop/hbase/UserMetrics.java

   1 /**
   2  * Copyright The Apache Software Foundation
   3  *
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20
  21 package org.apache.hadoop.hbase;
  22
  23 import java.util.Map;
  24
  25 import org.apache.hadoop.hbase.util.Bytes;
  26 import org.apache.yetus.audience.InterfaceAudience;
  27 import org.apache.yetus.audience.InterfaceStability;
  28
  29 /**
  30   * Encapsulates per-user load metrics.
  31   */
  32 @InterfaceAudience.Public
  33 @InterfaceStability.Evolving
  34 public interface UserMetrics {
  35
  36   interface ClientMetrics {
  37
  38     String getHostName();
  39
  40     long getReadRequestsCount();
  41
  42     long getWriteRequestsCount();
  43
  44     long getFilteredReadRequestsCount();
  45   }
  46
  47   /**
  48    * @return the user name
  49    */
  50   byte[] getUserName();
  51
  52   /**
  53    * @return the number of read requests made by user
  54    */
  55   long getReadRequestCount();
  56
  57   /**
  58    * @return the number of write requests made by user
  59    */
  60   long getWriteRequestCount();
  61
  62   /**
  63    * @return the number of write requests and read requests and coprocessor
  64    *         service requests made by the user
  65    */
  66   default long getRequestCount() {
  67     return getReadRequestCount() + getWriteRequestCount();
  68   }
  69
  70   /**
  71    * @return the user name as a string
  72    */
  73   default String getNameAsString() {
  74     return Bytes.toStringBinary(getUserName());
  75   }
  76
  77   /**
  78    * @return metrics per client(hostname)
  79    */
  80   Map<String, ClientMetrics> getClientMetrics();
  81
  82   /**
  83    * @return count of filtered read requests for a user
  84    */
  85   long getFilteredReadRequests();
  86 }