Package org.jenkinsci.plugins.executorsmonitor

Class ExecutorsMonitor

java.lang.Object
hudson.node_monitors.NodeMonitor
org.jenkinsci.plugins.executorsmonitor.ExecutorsMonitor
All Implemented Interfaces:
ExtensionPoint, Describable<NodeMonitor>
public class ExecutorsMonitor extends NodeMonitor
Reports the "busy/total/configured" executor counts of each node on the Nodes overview page. "total" is the number of executors currently allowed to be live on the computer, which may temporarily differ from "configured" (the node's configured executor count) if that count was lowered while some of its executors were still busy. This is purely informational: unlike the disk space or response time monitors, it does not define any threshold and never takes a node offline.

  • Constructor Details

    • ExecutorsMonitor

      @DataBoundConstructor public ExecutorsMonitor()

  • Method Details

    • readResolve

      protected Object readResolve()
      XStream reconstructs already-persisted instances without calling the constructor, so the queueThresholdFactor field initializer above never runs for configs saved before that field existed -- it silently comes back as the Java default of 0 instead. Since 0 (and 1) are not valid values anyway (see getQueueThresholdFactor()), treat them as "unset" here and repair them to the real default.

    • isColorize

      public boolean isColorize()
      Whether the busy/total counts should be colorized (blue/green/red) depending on how busy the node is. Defaults to false, i.e. the counts are rendered in the default color unless this is explicitly enabled.

    • setColorize

      @DataBoundSetter public void setColorize(boolean colorize)

    • isCountQueue

      public boolean isCountQueue()
      Whether to also report the number of buildable queue items that this node could pick up, similar to the per-agent build queue shown by the computer-queue-plugin. Defaults to false, since it requires scanning the whole build queue for every node on every page load.

    • setCountQueue

      @DataBoundSetter public void setCountQueue(boolean countQueue)

    • getQueueThresholdFactor

      public int getQueueThresholdFactor()
      When isColorize() and isCountQueue() are both enabled, the queued count is colorized blue when it is 0, green while it does not exceed the configured executor count, uncolored while it does not exceed configured * N, and red beyond that. Must be greater than 1 if set; defaults to 5.

    • setQueueThresholdFactor

      @DataBoundSetter public void setQueueThresholdFactor(int queueThresholdFactor)

    • getColumnCaption

      public String getColumnCaption()
      Overrides:
      getColumnCaption in class NodeMonitor

    • data

      public Object data(Computer c)
      Overrides:
      data in class NodeMonitor