Show Table of Contents
Chapter 8. Queue Service
Overview
| Description: | ActiveMQ Queue |
|---|---|
| Singleton: | no |
| Plugin: | ActiveMQ |
Parent Resource Types
Child Resource Types
none
Connection Properties
Table 8.1. Connection Properties
| Name | Required | Description | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Destination | yes | destination |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 8.2. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Enqueue Count | measurement | Number of messages that have been sent to the destination | EnqueueCount |
| Enqueue Count per Minute | measurement | Number of messages per minute that have been sent to the destination | EnqueueCount |
| Dequeue Count | measurement | Number of messages that have been acknowledged (and removed) from the destination. | DequeueCount |
| Dequeue Count per Minute | measurement | Number of messages per minute that have been acknowledged (and removed) from the destination. | DequeueCount |
| Forward Count | measurement | Number of messages forwarded from the destination to a networked broker. | ForwardCount |
| Forward Count per Minute | measurement | Number of messages forwarded per minute from the destination to a networked broker. | ForwardCount |
| Consumer Count | measurement | Number of consumers subscribed to this destination | ConsumerCount |
| Queue Size | measurement | Number of messages in the destination yet to be consumed. Potentially dispatched but unacknowledged. | QueueSize |
| Memory Percent Usage | measurement | The percentage of the memory limit used | MemoryPercentUsage |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 8.3. Operations
| Name | Description |
|---|---|
| Purge | Removes all of the messages in the queue |
| Remove Message | Remove a message from the destination by JMS message ID. If the message has been dispatched, it cannot be deleted and false is returned. |
| Remove Matching Messages | Removes up to a specified number of messages from the destination based on an SQL-92 selection on the message headers or XPATH on the body. |
| Copy Message To | Copies a message with the given JMS message ID into the specified destination. |
| Copy Matching Messages To | Copies up to a specified number of messages based on an SQL-92 selecton on the message headers or XPATH on the body into the specified destination. |
| Move Message To | Moves a message with the given JMS message ID into the specified destination. |
| Move Matching Messages To | Moves up to a specified number of messages based on an SQL-92 selecton on the message headers or XPATH on the body into the specified destination. |
| Retry Message | Moves a message with the given JMS message back to its original destination |
| Does Cursor Have Space | Message cursor has memory space available |
| Does Cursor Have Messages Buffered | Message cursor has buffered messages to deliver |
| Cursor Size | Number of messages available to be paged in by the cursor. |
| Reset Statistics | Resets statistics |
| Send Text Message | Sends a text message to this destination |
| Browse | Browse messages sent to this destination |
Package Types
none
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.