001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.master.balancer;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022/**
023 * This interface extends the basic metrics balancer source to add a function to report metrics that
024 * related to stochastic load balancer. The purpose is to offer an insight to the internal cost
025 * calculations that can be useful to tune the balancer. For details, refer to HBASE-13965
026 */
027@InterfaceAudience.Private
028public interface MetricsStochasticBalancerSource extends MetricsBalancerSource {
029
030  /**
031   * Updates the number of metrics reported to JMX
032   */
033  public void updateMetricsSize(int size);
034
035  /**
036   * Reports stochastic load balancer costs to JMX
037   */
038  public void updateStochasticCost(String tableName, String costFunctionName,
039    String costFunctionDesc, Double value);
040}