hadoop FederationMBean 源码

haddop FederationMBean 代码

文件路径：/hadoop-hdfs-project/hadoop-hdfs-rbf/src/main/java/org/apache/hadoop/hdfs/server/federation/metrics/FederationMBean.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hdfs.server.federation.metrics;

import java.math.BigInteger;

import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;

/**
 * JMX interface for the federation statistics.
 */
@InterfaceAudience.Private
@InterfaceStability.Evolving
public interface FederationMBean {

  /**
   * Get information about all the namenodes in the federation or null if
   * failure.
   * @return JSON with all the Namenodes.
   */
  String getNamenodes();

  /**
   * Get the latest info for each registered nameservice.
   * @return JSON with all the nameservices.
   */
  String getNameservices();

  /**
   * Get the mount table for the federated filesystem or null if failure.
   * @return JSON with the mount table.
   */
  String getMountTable();

  /**
   * Get the latest state of all routers.
   * @return JSON with all the known routers or null if failure.
   */
  String getRouters();

  /**
   * Get the total capacity of the federated cluster.
   * The number could overflow if too big. In that case use
   * {@link #getTotalCapacityBigInt()} instead.
   * @return Total capacity of the federated cluster.
   */
  long getTotalCapacity();

  /**
   * Get the used capacity of the federated cluster.
   * The number could overflow if too big. In that case use
   * {@link #getUsedCapacityBigInt()} instead.
   * @return Used capacity of the federated cluster.
   */
  long getUsedCapacity();

  /**
   * Get the remaining capacity of the federated cluster.
   * The number could overflow if too big. In that case use
   * {@link #getRemainingCapacityBigInt()} instead.
   * @return Remaining capacity of the federated cluster.
   */
  long getRemainingCapacity();

  /**
   * Get the total capacity (big integer) of the federated cluster.
   * @return Total capacity of the federated cluster.
   */
  BigInteger getTotalCapacityBigInt();

  /**
   * Get the used capacity (big integer) of the federated cluster.
   * @return Used capacity of the federated cluster.
   */
  BigInteger getUsedCapacityBigInt();

  /**
   * Get the remaining capacity (big integer) of the federated cluster.
   * @return Remaining capacity of the federated cluster.
   */
  BigInteger getRemainingCapacityBigInt();

  /**
   * Get the total remote storage capacity mounted in the federated cluster.
   * @return Remote capacity of the federated cluster.
   */
  long getProvidedSpace();

  /**
   * Get the number of nameservices in the federation.
   * @return Number of nameservices in the federation.
   */
  int getNumNameservices();

  /**
   * Get the number of namenodes.
   * @return Number of namenodes.
   */
  int getNumNamenodes();

  /**
   * Get the number of expired namenodes.
   * @return Number of expired namenodes.
   */
  int getNumExpiredNamenodes();

  /**
   * Get the number of live datanodes.
   * @return Number of live datanodes.
   */
  int getNumLiveNodes();

  /**
   * Get the number of dead datanodes.
   * @return Number of dead datanodes.
   */
  int getNumDeadNodes();

  /**
   * Get the number of stale datanodes.
   * @return Number of stale datanodes.
   */
  int getNumStaleNodes();

  /**
   * Get the number of decommissioning datanodes.
   * @return Number of decommissioning datanodes.
   */
  int getNumDecommissioningNodes();

  /**
   * Get the number of live decommissioned datanodes.
   * @return Number of live decommissioned datanodes.
   */
  int getNumDecomLiveNodes();

  /**
   * Get the number of dead decommissioned datanodes.
   * @return Number of dead decommissioned datanodes.
   */
  int getNumDecomDeadNodes();

  /**
   * Get the number of live datanodes which are under maintenance.
   * @return Number of live datanodes which are under maintenance.
   */
  int getNumInMaintenanceLiveDataNodes();

  /**
   * Get the number of dead datanodes which are under maintenance.
   * @return Number of dead datanodes which are under maintenance.
   */
  int getNumInMaintenanceDeadDataNodes();

  /**
   * Get the number of datanodes which are entering maintenance.
   * @return Number of datanodes which are entering maintenance.
   */
  int getNumEnteringMaintenanceDataNodes();

  /**
   * Get Max, Median, Min and Standard Deviation of DataNodes usage.
   * @return the DataNode usage information, as a JSON string.
   */
  String getNodeUsage();

  /**
   * Get the number of blocks in the federation.
   * @return Number of blocks in the federation.
   */
  long getNumBlocks();

  /**
   * Get the number of missing blocks in the federation.
   * @return Number of missing blocks in the federation.
   */
  long getNumOfMissingBlocks();

  /**
   * Get the number of pending replication blocks in the federation.
   * @return Number of pending replication blocks in the federation.
   */
  long getNumOfBlocksPendingReplication();

  /**
   * Get the number of under replicated blocks in the federation.
   * @return Number of under replicated blocks in the federation.
   */
  long getNumOfBlocksUnderReplicated();

  /**
   * Get the number of pending deletion blocks in the federation.
   * @return Number of pending deletion blocks in the federation.
   */
  long getNumOfBlocksPendingDeletion();

  /**
   * Get the number of files in the federation.
   * @return Number of files in the federation.
   */
  long getNumFiles();

  /**
   * When the router started.
   * @return Date as a string the router started.
   * @deprecated Use {@link RouterMBean#getRouterStarted()} instead.
   */
  @Deprecated
  String getRouterStarted();

  /**
   * Get the version of the router.
   * @return Version of the router.
   * @deprecated Use {@link RouterMBean#getVersion()} instead.
   */
  @Deprecated
  String getVersion();

  /**
   * Get the compilation date of the router.
   * @return Compilation date of the router.
   * @deprecated Use {@link RouterMBean#getCompiledDate()} instead.
   */
  @Deprecated
  String getCompiledDate();

  /**
   * Get the compilation info of the router.
   * @return Compilation info of the router.
   * @deprecated Use {@link RouterMBean#getCompileInfo()} instead.
   */
  @Deprecated
  String getCompileInfo();

  /**
   * Get the host and port of the router.
   * @return Host and port of the router.
   * @deprecated Use {@link RouterMBean#getHostAndPort()} instead.
   */
  @Deprecated
  String getHostAndPort();

  /**
   * Get the identifier of the router.
   * @return Identifier of the router.
   * @deprecated Use {@link RouterMBean#getRouterId()} instead.
   */
  @Deprecated
  String getRouterId();

  /**
   * Gets the cluster ids of the namenodes.
   * @return the cluster ids of the namenodes.
   * @deprecated Use {@link RouterMBean#getClusterId()} instead.
   */
  String getClusterId();

  /**
   * Gets the block pool ids of the namenodes.
   * @return the block pool ids of the namenodes.
   * @deprecated Use {@link RouterMBean#getBlockPoolId()} instead.
   */
  @Deprecated
  String getBlockPoolId();

  /**
   * Get the current state of the router.
   * @return String label for the current router state.
   * @deprecated Use {@link RouterMBean#getRouterStatus()} instead.
   */
  @Deprecated
  String getRouterStatus();

  /**
   * Get the current number of delegation tokens in memory.
   * @return number of DTs
   * @deprecated Use {@link RouterMBean#getCurrentTokensCount()} instead.
   */
  @Deprecated
  long getCurrentTokensCount();

  /**
   * Get the security status of the router.
   * @return Security status.
   * @deprecated Use {@link RouterMBean#isSecurityEnabled()} instead.
   */
  @Deprecated
  boolean isSecurityEnabled();

  /**
   * Get the number of corrupts files.
   *
   * @return the total number of corrupt files.
   */
  int getCorruptFilesCount();

  /**
   * Blocks scheduled for replication.
   *
   * @return num of blocks scheduled for replication.
   */
  long getScheduledReplicationBlocks();

  /**
   * Gets the total number of missing blocks on the cluster with
   * replication factor 1.
   *
   * @return the total number of missing blocks on the cluster with
   * replication factor 1.
   */
  long getNumberOfMissingBlocksWithReplicationFactorOne();

  /**
   * Gets the total number of replicated low redundancy blocks on the cluster
   * with the highest risk of loss.
   *
   * @return the total number of low redundancy blocks on the cluster
   * with the highest risk of loss.
   */
  long getHighestPriorityLowRedundancyReplicatedBlocks();

  /**
   * Gets the total number of erasure coded low redundancy blocks on the cluster
   * with the highest risk of loss.
   *
   * @return the total number of low redundancy blocks on the cluster
   * with the highest risk of loss.
   */
  long getHighestPriorityLowRedundancyECBlocks();

  /**
   * Returns the number of paths to be processed by storage policy satisfier.
   *
   * @return The number of paths to be processed by sps.
   */
  int getPendingSPSPaths();
}

相关信息

hadoop 源码目录

相关文章

hadoop FederationRPCMBean 源码

hadoop FederationRPCMetrics 源码

hadoop FederationRPCPerformanceMonitor 源码

hadoop NamenodeBeanMetrics 源码

hadoop NameserviceRPCMBean 源码

hadoop NameserviceRPCMetrics 源码

hadoop NullStateStoreMetrics 源码

hadoop RBFMetrics 源码

hadoop RouterMBean 源码

hadoop StateStoreMBean 源码