You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ch...@apache.org on 2011/06/08 18:46:07 UTC
svn commit: r1133463 - in
/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto:
AggregateQueueMetricsDTO.java QueueMetricsDTO.java
Author: chirino
Date: Wed Jun 8 16:46:07 2011
New Revision: 1133463
URL: http://svn.apache.org/viewvc?rev=1133463&view=rev
Log:
Add some javadoc to the Queue Metrics classes.
Modified:
activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateQueueMetricsDTO.java
activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/QueueMetricsDTO.java
Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateQueueMetricsDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateQueueMetricsDTO.java?rev=1133463&r1=1133462&r2=1133463&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateQueueMetricsDTO.java (original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateQueueMetricsDTO.java Wed Jun 8 16:46:07 2011
@@ -30,6 +30,9 @@ import javax.xml.bind.annotation.*;
@XmlAccessorType(XmlAccessType.FIELD)
public class AggregateQueueMetricsDTO extends QueueMetricsDTO {
+ /**
+ * The number of queues which where aggregated.
+ */
@XmlAttribute(name="queues")
public int queues;
Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/QueueMetricsDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/QueueMetricsDTO.java?rev=1133463&r1=1133462&r2=1133463&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/QueueMetricsDTO.java (original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/QueueMetricsDTO.java Wed Jun 8 16:46:07 2011
@@ -24,71 +24,159 @@ import javax.xml.bind.annotation.XmlRoot
/**
* <p>
+ * Collects metrics about the status of a queue since the
+ * time a broker gets started.
* </p>
*
+ * <p>
+ * Note that you may need to do a little math to compute how much
+ * the number of message swapped on disk:
+ *
+ * swapped_out_size = queue_size - swapped_in_size
+ *
+ * </p>
* @author <a href="http://hiramchirino.com">Hiram Chirino</a>
*/
@XmlRootElement(name="queue_metrics")
@XmlAccessorType(XmlAccessType.FIELD)
public class QueueMetricsDTO {
+ /**
+ * The number of messages that have been added to the queue.
+ * This includes any messages which were recovered from
+ * persistent storage when the broker was first started.
+ */
@XmlAttribute(name="enqueue_item_counter")
public long enqueue_item_counter;
+ /**
+ * The total size in bytes of messages that have been added
+ * to the queue. This includes any messages
+ * which were recovered from persistent storage when the broker
+ * was first started.
+ */
@XmlAttribute(name="enqueue_size_counter")
public long enqueue_size_counter;
+ /**
+ * The time stamp of when the last enqueue occurred.
+ */
@XmlAttribute(name="enqueue_ts")
public long enqueue_ts;
+ /**
+ * The number of messages that have been removed from the queue.
+ */
@XmlAttribute(name="dequeue_item_counter")
public long dequeue_item_counter;
+ /**
+ * The total size in bytes of messages that have been
+ * removed from the queue.
+ */
@XmlAttribute(name="dequeue_size_counter")
public long dequeue_size_counter;
+ /**
+ * The time stamp of when the last dequeue occurred.
+ */
@XmlAttribute(name="dequeue_ts")
public long dequeue_ts;
+ /**
+ * The number of messages that were delivered to
+ * a consumer but which the consumer did not successfully process.
+ */
@XmlAttribute(name="nack_item_counter")
public long nack_item_counter;
+ /**
+ * The total size in bytes of messages that were delivered to
+ * a consumer but which the consumer did not successfully process.
+ */
@XmlAttribute(name="nack_size_counter")
public long nack_size_counter;
+ /**
+ * The time stamp of when the last nack occurred.
+ */
@XmlAttribute(name="nack_ts")
public long nack_ts;
+ /**
+ * The total size in bytes of messages that are sitting in the queue.
+ */
@XmlAttribute(name="queue_size")
public long queue_size;
+ /**
+ * The total number of messages that are sitting in the queue.
+ */
@XmlAttribute(name="queue_items")
public long queue_items;
+ /**
+ * The maximum amount of RAM this queue will use to process in
+ * flight messages. The queue will either flow control producers
+ * or swap messages to persistent storage once this limit is reached.
+ */
+ @XmlAttribute(name="swapped_in_size_max")
+ public int swapped_in_size_max;
+
+ /**
+ * The total size in bytes of messages that are resident in
+ * the broker's RAM.
+ */
@XmlAttribute(name="swapped_in_size")
public int swapped_in_size;
+ /**
+ * The total number of messages that are resident in
+ * the broker's RAM.
+ */
@XmlAttribute(name="swapped_in_items")
public int swapped_in_items;
+ /**
+ * The total size in bytes of messages that are being
+ * loaded from persistent storage into RAM
+ */
@XmlAttribute(name="swapping_in_size")
public int swapping_in_size;
+ /**
+ * The total size in bytes of messages that are being
+ * evicted from RAM into persistent storage.
+ */
@XmlAttribute(name="swapping_out_size")
public int swapping_out_size;
- @XmlAttribute(name="swapped_in_size_max")
- public int swapped_in_size_max;
-
+ /**
+ * The total number of messages that have ever been
+ * moved from RAM into persistent storage.
+ */
@XmlAttribute(name="swap_out_item_counter")
public long swap_out_item_counter;
+ /**
+ * The total size in bytes of messages that have ever been
+ * moved from RAM into persistent storage.
+ */
@XmlAttribute(name="swap_out_size_counter")
public long swap_out_size_counter;
+ /**
+ * The total number of messages that have ever been
+ * moved from persistent storage into RAM.
+ */
@XmlAttribute(name="swap_in_item_counter")
public long swap_in_item_counter;
+ /**
+ * The total size in bytes of messages that have ever been
+ * moved from persistent storage into RAM.
+ */
@XmlAttribute(name="swap_in_size_counter")
public long swap_in_size_counter;
+
}