View Javadoc

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.balancer;
20  
21  /**
22   * This interface extends the basic metrics balancer source to add a function
23   * to report metrics that related to stochastic load balancer. The purpose is to
24   * offer an insight to the internal cost calculations that can be useful to tune
25   * the balancer. For details, refer to HBASE-13965
26   */
27  public interface MetricsStochasticBalancerSource extends MetricsBalancerSource {
28  
29    /**
30     * Updates the number of metrics reported to JMX
31     */
32    public void updateMetricsSize(int size);
33  
34    /**
35     * Reports stochastic load balancer costs to JMX
36     */
37    public void updateStochasticCost(String tableName, String costFunctionName,
38        String costFunctionDesc, Double value);
39  }