com.ibm.streams.operator.control

Interface RegionMonitorMXBean

  • All Superinterfaces:
    PersistentControlMBean

    public interface RegionMonitorMXBean
extends PersistentControlMBean
    Monitors a region, a set of operators, within the current job. At runtime operators execute within processing elements (PEs), so RegionMonitorMXBean monitors the health of the PEs containing all the operators in the region.
    This bean provides these attributes for the monitored region:
    • Running - The region is defined to be running if all of its PEs are running.
    • Health - The health of the region is a aggregation of the health of its PEs.

    Attribute change notifications are generated for these two attributes.

    The health of a region is defined by the health of the processing elements in the region. If all the processing elements are healthy, then the region is defined as healthy. If at least one processing element is unhealthy, then the region is unhealthy.

    Since:
    InfoSphere® Streams Version 4.0
    See Also:
    ControlPlaneMXBean.registerRegionMonitor(String, Set)

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface and Description
      static class  RegionMonitorMXBean.Health
      The health of a region as an aggregation of the health of the PEs for the region.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String PE_USER_REQUEST
      Notification that a PE in the region was stopped or restarted by a user request.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Boolean getCleanStart()
      Return true if the region experienced a clean start.
      RegionMonitorMXBean.Health getHealth()
      Health of the region as an aggregation of the health of PE's within the region.
      java.lang.String getName()
      Return the name of region.
      java.util.Set<java.math.BigInteger> getPes()
      Return the set of processing elements containing all the operators in the monitored region.
      boolean isRunning()
      Is the region running.

    • Field Detail

      • PE_USER_REQUEST

        static final java.lang.String PE_USER_REQUEST
        Notification that a PE in the region was stopped or restarted by a user request. User data is the PE identifier (BigInteger).
        See Also:
        Constant Field Values

    • Method Detail

      • getName

        java.lang.String getName()
        Return the name of region.

      • getPes

        java.util.Set<java.math.BigInteger> getPes()
        Return the set of processing elements containing all the operators in the monitored region. All processing elements are part of the current job.
        Returns:
        the set of processing elements within this region.

      • getHealth

        RegionMonitorMXBean.Health getHealth()
        Health of the region as an aggregation of the health of PE's within the region. A javax.management.AttributeChangeNotification (type = jmx.attribute.change) is issued when the health of the region changes.
        Returns:
        Health of the region.

      • isRunning

        boolean isRunning()
        Is the region running. The region is running if all of its processing elements are in the RUNNING state.
        Returns:
        True the region is running, false if at least one processing element in the region is not running.

      • getCleanStart

        java.lang.Boolean getCleanStart()
        Return true if the region experienced a clean start. A clean start was obtained if each PE in the region reached RUNNING state and HEALTHY health without:
        Returns:
        True if the region experienced a clean start.