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.replication.regionserver;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022@InterfaceAudience.Private
023public interface MetricsReplicationGlobalSourceSource extends MetricsReplicationSourceSource {
024
025  public static final String SOURCE_WAL_READER_EDITS_BUFFER = "source.walReaderEditsBufferUsage";
026
027  /**
028   * Sets the total usage of memory used by edits in memory read from WALs. The memory represented
029   * by this usage measure is across peers/sources. For example, we may batch the same WAL edits
030   * multiple times for the sake of replicating them to multiple peers..
031   * @param usage The memory used by edits in bytes
032   */
033  void setWALReaderEditsBufferBytes(long usage);
034
035  /**
036   * Returns the size, in bytes, of edits held in memory to be replicated across all peers.
037   */
038  long getWALReaderEditsBufferBytes();
039}