Interface MonitorHealthMBean

  • All Known Implementing Classes:
    MonitorHealth

    @Description("A monitoring MBean for the LumisXP monitoring framework.")
    @Name("LumisXP: Monitor Health")
    public interface MonitorHealthMBean
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      double getItemAddedAverageThroughput()
      Health indicator of the average of the throughput of items added in monitor process queue (how many items have been added in one second).
      double getItemProcessedAverageThroughput()
      Health indicator of the average of the throughput of items processed in monitor process queue (how many items have been added in one second).
      double getItemRejectedAverageThroughput()
      Health indicator of the average of the throughput of items rejected by the monitor process queue (how many items have been rejected in one second).
      int getNumberOfActiveThreads()
      Health indicator of the number of currently active monitor process threads.
      int getNumberOfThreads()
      Health indicator of the number of monitor process threads.
      int getProcessQueueMaximumSize()
      Heath indicator of the monitoring process queue maximum size.
      int getProcessQueueSize()
      Heath indicator of the monitoring process queue size.
      double getQueueAverageDuration()
      Health indicator of the average of the duration an item remains on the process queue, since it was added until it is fully processed.
    • Method Detail

      • getProcessQueueSize

        @Name("Process queue size")
        @Description("The monitor process queue current size")
        int getProcessQueueSize()
                         throws java.lang.Exception
        Heath indicator of the monitoring process queue size.
        Returns:
        the monitoring process queue size.
        Throws:
        java.lang.Exception
        Since:
        12.2.0
      • getProcessQueueMaximumSize

        @Name("Process queue maximum size")
        @Description("The monitor process queue maximum size")
        int getProcessQueueMaximumSize()
                                throws java.lang.Exception
        Heath indicator of the monitoring process queue maximum size.
        Returns:
        the monitoring process queue maximum size.
        Throws:
        java.lang.Exception
        Since:
        12.2.0
      • getItemAddedAverageThroughput

        @Name("Items added average throughput")
        @Description("The average throughput of items added to process queue (items per second)")
        @Units("items / second")
        double getItemAddedAverageThroughput()
                                      throws java.lang.Exception
        Health indicator of the average of the throughput of items added in monitor process queue (how many items have been added in one second).
        Returns:
        the average of the throughput of items added in monitor process queue (how many items were added in one second).
        Throws:
        java.lang.Exception
        Since:
        12.2.0
      • getItemRejectedAverageThroughput

        @Name("Items rejected average throughput")
        @Description("The average throughput of rejected items by the process queue (items per second)")
        @Units("items / second")
        double getItemRejectedAverageThroughput()
                                         throws java.lang.Exception
        Health indicator of the average of the throughput of items rejected by the monitor process queue (how many items have been rejected in one second).
        Returns:
        the average of the throughput of items rejected by the monitor process queue (how many items have been rejected in one second).
        Throws:
        java.lang.Exception
        Since:
        12.2.0
      • getItemProcessedAverageThroughput

        @Name("Items processed average throughput")
        @Description("The average throughput of items processed in process queue (items per second)")
        @Units("items / second")
        double getItemProcessedAverageThroughput()
                                          throws java.lang.Exception
        Health indicator of the average of the throughput of items processed in monitor process queue (how many items have been added in one second).
        Returns:
        the average of the throughput of items processed in monitor process queue (how many items have been added in one second).
        Throws:
        java.lang.Exception
        Since:
        12.2.0
      • getQueueAverageDuration

        @Name("Average duration of an item in process queue")
        @Description("The average duration (in milliseconds) of an item in process queue (the duration betwee the item is added to the queue and it is fully processed)")
        @Units("milliseconds")
        double getQueueAverageDuration()
                                throws java.lang.Exception
        Health indicator of the average of the duration an item remains on the process queue, since it was added until it is fully processed.
        Returns:
        the average of the duration an item remains on the process queue, since it was added until it is fully processed.
        Throws:
        java.lang.Exception
        Since:
        12.2.0
      • getNumberOfActiveThreads

        @Name("Number of active threads")
        @Description("The number of process threads that are currently active")
        int getNumberOfActiveThreads()
        Health indicator of the number of currently active monitor process threads.
        Returns:
        the number of currently active monitor process threads.
        Since:
        12.2.0
      • getNumberOfThreads

        @Name("Number of threads")
        @Description("The number of process threads")
        int getNumberOfThreads()
        Health indicator of the number of monitor process threads.
        Returns:
        the number of monitor process threads.
        Since:
        12.2.0