Where to find all QMF methods and their arguments for qpid broker?
Environment
Red Hat Enterprise MRG Messaging
Issue
Wishing to manage broker via QMF, we would like to know:
- where to find all manageable classes?
- What are their attributes, methods and their arguments?
Resolution
There are two ways of getting the list of QMF methods:
- See management schema xml either in:
- Content from svn.apache.org is not included.upstream - where it contains also some methods or arguments of methods that are not present in MRG yet
- source RPM where to search for all
management-schema.xmlfiles
- run
qpid-toolagainst a running broker and typeschemaorschema <class>:
$ qpid-tool
Management Tool for QPID
qpid: schema
QMF Classes:
Package Name Kind
======================================================
com.redhat.rhm.store journal object
com.redhat.rhm.store store object
org.apache.qpid.broker system object
org.apache.qpid.broker managementsetupstate object
org.apache.qpid.broker binding object
org.apache.qpid.broker memory object
org.apache.qpid.broker queue object
org.apache.qpid.broker exchange object
org.apache.qpid.broker bridge object
org.apache.qpid.broker session object
org.apache.qpid.broker subscription object
org.apache.qpid.broker agent object
org.apache.qpid.broker link object
org.apache.qpid.broker connection object
org.apache.qpid.broker broker object
org.apache.qpid.broker vhost object
qpid: schema queue
Object Class: Table Class: org.apache.qpid.broker:queue:_data(eea79fae-cc9b-f028-eab3-7d4af740d427)
Element Type Access Unit Notes Description
==================================================================================================================================================
vhostRef reference ReadCreate index
name short-string ReadCreate index
durable boolean ReadCreate
autoDelete boolean ReadCreate
exclusive boolean ReadOnly
arguments field-table ReadOnly Arguments supplied in queue.declare
altExchange reference ReadOnly optional
msgTotalEnqueues uint64 message Total messages enqueued
msgTotalDequeues uint64 message Total messages dequeued
msgTxnEnqueues uint64 message Transactional messages enqueued
msgTxnDequeues uint64 message Transactional messages dequeued
msgPersistEnqueues uint64 message Persistent messages enqueued
msgPersistDequeues uint64 message Persistent messages dequeued
msgDepth uint64 message Current size of queue in messages
byteDepth uint64 octet Current size of queue in bytes
byteTotalEnqueues uint64 octet Total messages enqueued
byteTotalDequeues uint64 octet Total messages dequeued
byteTxnEnqueues uint64 octet Transactional messages enqueued
byteTxnDequeues uint64 octet Transactional messages dequeued
bytePersistEnqueues uint64 octet Persistent messages enqueued
bytePersistDequeues uint64 octet Persistent messages dequeued
msgFtdEnqueues uint64 message Total message bodies released from memory and flowed-to-disk on broker
msgFtdDequeues uint64 message Total message bodies dequeued from the broker having been flowed-to-disk
byteFtdEnqueues uint64 octet Total bytes released from memory and flowed-to-disk on broker
byteFtdDequeues uint64 octet Total bytes dequeued from the broker having been flowed-to-disk
msgFtdDepth uint64 message Current number of messages flowed-to-disk
byteFtdDepth uint64 octet Current number of bytes flowed-to-disk
releases uint64 message Acquired messages reinserted into the queue
acquires uint64 message Messages acquired from the queue
discardsTtl uint64 message Messages discarded due to TTL expiration
discardsRing uint64 message Messages discarded due to ring-queue overflow
discardsLvq uint64 message Messages discarded due to LVQ insert
discardsOverflow uint64 message Messages discarded due to reject-policy overflow
discardsSubscriber uint64 message Messages discarded due to subscriber reject
discardsPurge uint64 message Messages discarded due to management purge
reroutes uint64 message Messages dequeued to management re-route
consumerCount uint32 consumer Current consumers on queue
consumerCountHigh uint32 consumer Current consumers on queue (High)
consumerCountLow uint32 consumer Current consumers on queue (Low)
bindingCount uint32 binding Current bindings
bindingCountHigh uint32 binding Current bindings (High)
bindingCountLow uint32 binding Current bindings (Low)
unackedMessages uint32 message Messages consumed but not yet acked
unackedMessagesHigh uint32 message Messages consumed but not yet acked (High)
unackedMessagesLow uint32 message Messages consumed but not yet acked (Low)
messageLatencySamples delta-time nanosecond Broker latency through this queue (Samples)
messageLatencyMin delta-time nanosecond Broker latency through this queue (Min)
messageLatencyMax delta-time nanosecond Broker latency through this queue (Max)
messageLatencyAverage delta-time nanosecond Broker latency through this queue (Average)
flowStopped boolean Flow control active.
flowStoppedCount uint32 Number of times flow control was activated for this queue
Method: purge
Argument Type Direction Unit Description
======================================================================================================
request uint32 I 0 for all messages or n>0 for n messages
filter field-table I if specified, purge only those messages matching this filter
Method: reroute
Argument Type Direction Unit Description
==================================================================================================================================================================
request uint32 I 0 for all messages or n>0 for n messages
useAltExchange boolean I Iff true, use the queue's configured alternate exchange; iff false, use exchange named in the 'exchange' argument
exchange short-string I Name of the exchange to route the messages through
filter field-table I if specified, reroute only those messages matching this filter
qpid:
SBR
Product(s)
Components
Category
Tags
This solution is part of Red Hat’s fast-track publication program, providing a huge library of solutions that Red Hat engineers have created while supporting our customers. To give you the knowledge you need the instant it becomes available, these articles may be presented in a raw and unedited form.