helix-core/src/main/java/org/apache/helix/monitoring/mbeans/InstanceMonitorMBean.java

package org.apache.helix.monitoring.mbeans;

/*
 * 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.
 */

import org.apache.helix.monitoring.SensorNameProvider;

/**
 * A basic bean describing the status of a single instance
 */
public interface InstanceMonitorMBean extends SensorNameProvider {
  /**
   * Check if this instance is live
   * @return 1 if running, 0 otherwise
   */
  public long getOnline();

  /**
   * Check if this instance is enabled
   * @return 1 if enabled, 0 if disabled
   */
  public long getEnabled();

  /**
   * Get total message received for this instances
   * @return The total number of messages sent to this instance
   */
  public long getTotalMessageReceived();

  /**
   * Get the total disabled partitions number for this instance
   * @return The total number of disabled partitions
   */
  public long getDisabledPartitions();
}