This chapter provides reference information on the use of the Message QueueTM command line administration utilities. It consists of the following sections:
Message Queue command line utilities are shell commands. The name of the utility is a command and its subcommands or options are arguments passed to that command. There is no need for separate commands to start or quit the utility.
All the command line utilities share the following command syntax:
utilityName [subcommand] [commandArgument] [ [-optionName [optionArgument]] … ]
where utilityName is one of the following:
imqbrokerd (Broker utility)
imqcmd (Command utility)
imqobjmgr (Object Manager utility)
imqdbmgr (Database Manager utility)
imqusermgr (User Manager utility)
imqsvcadmin (Service Administrator utility)
imqkeytool (Key Tool utility)
Subcommands and command-level arguments, if any, must precede all options and their arguments; the options themselves may appear in any order. All subcommands, command arguments, options, and option arguments are separated with spaces. If the value of an option argument contains a space, the entire value must be enclosed in quotation marks. (It is generally safest to enclose any attribute-value pair in quotation marks.)
The following command, which starts the default broker, is an example of a command line with no subcommand clause:
imqbrokerd
Here is a fuller example:
imqcmd destroy dst -t q -n myQueue -u admin -f -s
This command destroys a queue destination (destination type q) named myQueue. Authentication is performed on the user name admin; the command will prompt for a password. The command will be performed without prompting for confirmation (-f option) and in silent mode, without displaying any output (-s option).
The Broker utility (imqbrokerd) starts a broker. Command line options override values in the broker configuration files, but only for the current broker session.
Table 13–1 shows the options to the imqbrokerd command and the configuration properties, if any, overridden by each option.
Table 13–1 Broker Utility Options
Option |
Properties Overridden |
Description |
---|---|---|
-name instanceName |
imq.instancename |
Multiple broker instances running on the same host must have different instance names. Default value: imqbroker |
-port portNumber |
imq.portmapper.port |
Port number for broker’s Port Mapper Message Queue clients use this port number to connect to the broker. Multiple broker instances running on the same host must have different Port Mapper port numbers. Default value: 7676 |
-cluster broker1 [ [ ,broker2 ] … ] |
imq.cluster.brokerlist |
Connect brokers into cluster [Applies only to broker clusters] The specified brokers are merged with the list in the imq.cluster.brokerlist property. Each broker argument has one of the forms hostName:portNumber hostName :portNumber If hostName is omitted, the default value is localhost; if portNumber is omitted, the default value is 7676. |
-Dproperty=value |
Corresponding property in instance configuration file |
Set configuration property See Chapter 14, Broker Properties Reference for information about broker configuration properties. Caution: Be careful to check the spelling and formatting of properties set with this option. Incorrect values will be ignored without notification or warning. |
-reset props |
None |
Reset configuration properties Replaces the broker’s existing instance configuration file config.properties with an empty file; all properties assume their default values. |
-reset store |
None |
Reset persistent data store Clears all persistent data from the data store (including persistent messages, durable subscriptions, and transaction information), allowing you to start the broker instance with a clean slate. To prevent the persistent store from being reset on subsequent restarts, restart the broker instance without the -reset option. To clear only persistent messages or durable subscriptions, use -reset messages or -reset durables instead. |
-reset messages |
None |
Clear persistent messages from data store |
-reset durables |
None |
Clear durable subscriptions from data store |
-backup fileName |
None |
Back up configuration change record to file See Managing the Configuration Change Record for more information. |
-restore fileName |
None |
Restore configuration change record from backup file The backup file must have been previously created using the -backup option. See Managing the Configuration Change Record for more information. |
-remove instance |
None |
Remove broker instance [Requires user confirmation unless -force is also specified] Deletes the instance configuration file, log files, persistent store, and other files and directories associated with the instance. |
-password keyPassword |
imq.keystore.password |
Password for SSL certificate key store [This option is deprecated and will eventually be removed. Either omit the password (so that the user will be prompted for it interactively) or use the -passfile option to specify a file containing the password. ] |
-dbuser userName |
imq.persist.jdbc.user |
User name for JDBC-based persistent data store |
-dbpassword dbPassword |
imq.persist.jdbc.password |
Password for JDBC-based persistent data store |
-ldappassword ldapPassword |
imq.user_repository.ldap.password |
Password for LDAP user repository |
-passfile filePath |
imq.passfile.enabledimq.passfile.dirpathimq.passfile.name |
Sets the broker’s imq.passfile.enabled property to true, imq.passfile.dirpath to the path containing the password file, and imq.passfile.name to the file name itself. See Password Files for more information. |
-shared |
imq.jms.threadpool_model |
Use shared thread pool model to implement jms connection service Execution threads will be shared among connections to increase the number of connections supported. Sets the broker’s imq.jms.threadpool_model property to shared. |
-javahome path |
None |
Location of alternative Java runtime Default behavior: Use runtime installed on system or bundled with Message Queue. |
-vmargs arg1 [ [ arg2 ] … ] |
None |
Pass arguments to Java virtual machine Arguments are separated with spaces. To pass more than one argument, or an argument containing a space, enclose the argument list in quotation marks. VM arguments can be passed only from the command line; there is no associated configuration property in the instance configuration file. |
-license [ licenseName ] |
None |
License to load, if different from default for installed edition of Message Queue product: pe: Platform Edition with basic features try: Platform Edition with enterprise features (90-day trial) unl: Enterprise Edition If no license name is specified, all licenses installed on the system are listed. |
-upgrade-store-nobackup |
None |
Automatically remove old data store on upgrade to Message Queue 3.5 or 3.5 SPx from an incompatible version See the Message Queue Installation Guide for more information. |
-force |
None |
Perform action without user confirmation This option applies only to the -remove instance and -upgrade-store-nobackup options, which normally require confirmation. |
-loglevel level |
imq.broker.log.level |
NONE ERROR WARNING INFO Default value: INFO |
-metrics interval |
imq.metrics.interval | |
-tty |
imq.log.console.output |
Log all messages to console Sets the broker’s imq.log.console.output property to ALL. If not specified, only error and warning messages will be logged. |
-s | -silent |
imq.log.console.output |
Silent mode (no logging to console) Sets the broker’s imq.log.console.output property to NONE. |
-version |
None |
Display version information [Any other options specified on the command line are ignored. ] |
-h | -help |
None |
Display usage help |
The Command utility (imqcmd) is used for managing brokers, connection services, connections, physical destinations, durable subscriptions, and transactions.
All imqcmd commands must include a subcommand (except those using the -v or -h option to display product version information or usage help). The possible subcommands are listed here and described in detail in the corresponding sections below. In all cases, if the subcommand accepts a broker address (-b option) and no host name or port number is specified, the values localhost and 7676 are assumed by default.
shutdown bkr |
Shut down broker |
restart bkr |
Restart broker |
pause bkr |
Pause broker |
resume bkr |
Resume broker |
update bkr |
Set broker properties |
reload cls |
Reload cluster configuration |
query bkr |
List broker property values |
metrics bkr |
Display broker metrics |
pause svc |
Pause connection service |
resume svc |
Resume connection service |
update svc |
Set connection service properties |
list svc |
List connection services available on broker |
query svc |
List connection service property values |
metrics svc |
Display connection service metrics |
list cxn |
List connections on broker |
query cxn |
Display connection information |
create dst |
Create physical destination |
destroy dst |
Destroy physical destination |
pause dst |
Pause message delivery for physical destination |
resume dst |
Resume message delivery for physical destination |
update dst |
Set physical destination properties |
purge dst |
Purge all messages from physical destination |
compact dst |
Compact physical destination |
list dst |
List physical destinations |
query dst |
List physical destination property values |
metrics dst |
Display physical destination metrics |
destroy dur |
Destroy durable subscription |
purge dur |
Purge all messages for durable subscription |
list dur |
List durable subscriptions for topic |
commit txn |
Commit transaction |
rollback txn |
Roll back transaction |
list txn |
List transactions being tracked by broker |
query txn |
Display transaction information |
The Command utility cannot be used to start a broker; use the Broker utility (imqbrokerd) instead. Once the broker is started, you can use the imqcmd subcommands listed in Table 13–2 to manage and control it.
Table 13–2 Command Utility Subcommands for Broker Management
Syntax |
Description |
---|---|
shutdown bkr [-b hostName:portNumber] | |
restart bkr [-b hostName:portNumber] |
Shuts down the broker and then restarts it using the same options specified when it was originally started. |
pause bkr [-b hostName:portNumber] |
See Pausing a Broker for more information. |
resume bkr [-b hostName:portNumber] | |
update bkr [-b hostName:portNumber] -o property1=value1 [ [-o property2=value2] … ] |
Set broker properties See Chapter 14, Broker Properties Reference for information on broker properties. |
reload cls |
Reload cluster configuration [Applies only to broker clusters] Forces all persistent information to be brought up to date. |
query bkr -b hostName:portNumber |
List broker property values Also lists all running brokers connected to the specified broker in a cluster. |
metrics bkr [-b hostName:portNumber] [-m metricType] [-int interval] [-msp numSamples] |
Display broker metrics The -m option specifies the type of metrics to display: ttl: Messages and packets flowing into and out of the broker rts: Rate of flow of messages and packets into and out of the broker per second cxn: Connections, virtual memory heap, and threads Default value: ttl. The -int option specifies the interval, in seconds, at which to display metrics. Default value: 5. The -msp option specifies the number of samples to display. Default value: Unlimited (infinite). |
Table 13–3 lists the imqcmd subcommands for managing connection services.
Table 13–3 Command Utility Subcommands for Connection Service Management
Syntax |
Description |
---|---|
pause svc -n serviceName [-b hostName:portNumber] |
The admin connection service cannot be paused. |
resume svc -n serviceName [-b hostName:portNumber] | |
update svc -n serviceName [-b hostName:portNumber] -o property1=value1 [ [-o property2=value2] … ] |
Set connection service properties See Connection Properties for information on connection service properties. |
list svc [-b hostName:portNumber] |
List connection services available on broker |
query svc -n serviceName [-b hostName:portNumber] |
List connection service property values |
metrics svc -n serviceName [-b hostName:portNumber] [-m metricType] [-int interval] [-msp numSamples] |
Display connection service metrics The -m option specifies the type of metrics to display: ttl: Messages and packets flowing into and out of the broker by way of the specified connection service rts: Rate of flow of messages and packets into and out of the broker per second by way of the specified connection service cxn: Connections, virtual memory heap, and threads Default value: ttl. The -int option specifies the interval, in seconds, at which to display metrics. Default value: 5. The -msp option specifies the number of samples to display. Default value: Unlimited (infinite). |
Table 13–4 lists the imqcmd subcommands for managing connections.
Table 13–4 Command Utility Subcommands for Connection Service Management
Table 13–5 lists the imqcmd subcommands for managing physical destinations. In all cases, the -t (destination type) option can take either of two values:
q: Queue destination
t: Topic destination
Syntax |
Description |
---|---|
create dst -t destType -n destName [-o property1=value1] [ [ -o property2=value2] … ] |
Create physical destination [Cannot be performed in a broker cluster whose master broker is temporarily unavailable] The destination name destName may contain only alphanumeric characters (no spaces) and must begin with an alphabetic character or the underscore (_) or dollar sign ($) character. It may not begin with the characters mq. |
destroy dst -t destType -n destName |
Destroy physical destination This operation cannot be applied to a system-created destination, such as a dead message queue. |
pause dst [-t destType -n destName] [-pst pauseType] |
Pause message delivery for physical destination Pauses message delivery for the physical destination specified by the -t and -n options. If these options are not specified, all destinations are paused. The -pst option specifies the type of message delivery to be paused: CONSUMERS: Pause delivery to message consumers PRODUCERS: Pause delivery to message producers ALL: Pause all message delivery Default value: ALL |
resume dst [-t destType -ndestName] |
Resume message delivery for physical destination Resumes message delivery for the physical destination specified by the -t and -n options. If these options are not specified, all destinations are resumed. |
update dst -t destType -n destName -o property1=value1 [ [ -o property2=value2] … ] |
Set physical destination properties See Chapter 15, Physical Destination Property Reference for information on physical destination properties. |
purge dst -t destType -n destName | |
compact dst [-t destType -n destName] |
Compacts the file-based persistent data store for the physical destination specified by the -t and -n options. If these options are not specified, all destinations are compacted. A destination must be paused before it can be compacted. |
list dst [-t destType] [-tmp] |
List physical destinations Lists all physical destinations of the type specified by the -t option. If no destination type is specified, both queue and topic destinations are listed. If the -tmp option is specified, temporary destinations are listed as well. |
query dst -t destType -n destName | |
metrics dst -t destType -n destName [-m metricType] [-int interval] [-msp numSamples] |
Display physical destination metrics The -m option specifies the type of metrics to display: ttl: Messages and packets flowing into and out of the destination and residing in memory rts: Rate of flow of messages and packets into and out of the broker per second, along with other rate information con: Metrics related to message consumers dsk: Disk usage Default value: ttl. The -int option specifies the interval, in seconds, at which to display metrics. Default value: 5. The -msp option specifies the number of samples to display. Default value: Unlimited (infinite). |
Table 13–6 lists the imqcmd subcommands for managing durable subscriptions.
Table 13–6 Command Utility Subcommands for Durable Subscription Management
Table 13–7 lists the imqcmd subcommands for managing transactions.
Table 13–7 Command Utility Subcommands for Transaction Management
Syntax |
Description |
---|---|
commit txn -n transactionID | |
rollback txn -n transactionID | |
list txn | |
query txn -n transactionID |
The additional options listed in Table 13–8 can be applied to any subcommand of the imqcmd command.
Table 13–8 General Command Utility Options
Option |
Description |
---|---|
-secure |
Use secure connection to broker with ssladmin connection service |
-u userName |
User name for authentication If this option is omitted, the Command utility will prompt for it interactively. |
-p password |
Password for authentication [This option is deprecated and will eventually be removed. Either omit the password (so that the user will be prompted for it interactively) or use the -passfile option to specify a file containing the password. ] |
-passfile path |
Location of password file See Password Files for more information. |
-rtm timeoutInterval |
Initial timeout interval, in seconds This is the initial length of time that the Command utility will wait for a reply from the broker before retrying a request. Each subsequent retry will use a timeout interval that is a multiple of this initial interval. Default value: 10. |
-rtr numRetries |
Number of retries to attempt after a broker request times out Default value: 5. |
-javahome path |
Location of alternative Java runtime Default behavior: Use runtime installed on system or bundled with Message Queue. |
-f |
Perform action without user confirmation |
-s |
Silent mode (no output displayed) |
-v |
Display version information [Any other options specified on the command line are ignored. ] , [User name and password not needed] |
-h | |
-H |
Display expanded usage help, including attribute list and examples, |
The Object Manager utility (imqobjmgr) creates and manages Message Queue administered objects. Table 13–9 lists the available subcommands.
Table 13–9 Object Manager Subcommands
Subcommand |
Description |
---|---|
add |
Add administered object to object store |
delete |
Delete administered object from object store |
list |
List administered objects in object store |
query |
Display administered object information |
update |
Modify administered object |
Table 13–10 lists the options to the imqobjmgr command.
Table 13–10 Object Manager Options
Option |
Description |
---|---|
-l lookupName |
JNDI lookup name of administered object |
-j attribute=value |
Attributes of JNDI object store (see Object Stores) |
-t objectType |
Type of administered object: q: Queue destination t: Topic destination cf: Connection factory qf: Queue connection factory tf: Topic connection factory xcf: Connection factory for distributed transactions xqf: Queue connection factory for distributed transactions xtf: Topic connection factory for distributed transactions e: SOAP endpoint (see Message Queue Developer's Guide for Java Clients) |
-o attribute=value |
Attributes of administered object (see Administered Object Attributes and Chapter 16, Administered Object Attribute Reference) |
-r readOnlyState |
Is administered object read-only? If true, client cannot modify object’s attributes. Default value: false. |
-i fileName |
Name of command file containing all or part of subcommand clause |
-pre |
Preview results without performing command This option is useful for checking the values of default attributes. |
-javahome path |
Location of alternative Java runtime Default behavior: Use runtime installed on system or bundled with Message Queue. |
-f |
Perform action without user confirmation |
-s |
Silent mode (no output displayed) |
-v |
Display version information [Any other options specified on the command line are ignored. ] |
-h |
Display usage help |
-H |
Display expanded usage help, including attribute list and examples |
The Database Manager utility (imqdbmgr) sets up the database schema for a JDBC-based persistent data store. You can also use it to delete Message Queue database tables that have become corrupted or to change the data store. Table 13–11 lists the available subcommands.
Table 13–11 Database Manager Subcommands
Subcommand |
Description |
---|---|
create all |
Create new database and persistent store schema Used on embedded database systems. The broker property imq.persist.jdbc.createdburl must be specified. |
create tbl |
Create persistent store schema for existing database Used on external database systems. |
delete tbl |
Delete Message Queue database tables from current persistent store |
delete oldtbl |
Delete Message Queue database tables from earlier-version persistent store Used after the persistent store has been automatically migrated to the current version of Message Queue. |
recreate tbl |
Re-create persistent store schema Deletes all existing Message Queue database tables from the current persistent store and then re-creates the schema. |
reset lck |
Reset persistent store lock Resets the lock so that the persistent store database can be used by other processes. |
Table 13–12 lists the options to the imqdbmgr command.
Table 13–12 Database Manager Options
Option |
Description |
---|---|
-b instanceName |
Instance name of broker |
-Dproperty= value |
Set broker configuration property See Persistence Properties for information about persistence-related broker configuration properties. Caution: Be careful to check the spelling and formatting of properties set with this option. Incorrect values will be ignored without notification or warning. |
-u name |
User name for authentication |
-p password |
Password for authentication [This option is deprecated and will eventually be removed. Either omit the password (so that the user will be prompted for it interactively) or use the -passfile option to specify a file containing the password. ] |
-passfile path |
Location of password file See Password Files for more information. |
-v |
Display version information [Any other options specified on the command line are ignored. ] |
-h |
Display usage help |
The User Manager utility (imqusermgr) is used for populating or editing a flat-file user repository. The utility must be run on the same host where the broker is installed; if a broker-specific user repository does not yet exist, you must first start up the corresponding broker instance in order to create it. You will also need the appropriate permissions to write to the repository: on the Solaris or Linux platforms, this means you must be either the root user or the user who originally created the broker instance.
Table 13–13 lists the subcommands available with the imqusermgr command. In all cases, the -i option specifies the instance name of the broker to whose user repository the command applies; if not specified, the default name imqbroker is assumed.
Table 13–13 User Manager Subcommands
In addition, the options listed in Table 13–14 can be applied to any subcommand of the imqusermgr command.
Table 13–14 General User Manager Options
The Service Administrator utility (imqsvcadmin) installs a broker as a Windows service. Table 13–15 lists the available subcommands.
Table 13–15 Service Administrator Subcommands
Subcommand |
Description |
---|---|
install |
Install service |
remove |
Remove service |
query |
Display startup options Startup options can include whether the service is started manually or automatically, its location, the location of the Java runtime, and the values of arguments passed to the broker on startup (see Table 13–16). |
Table 13–16 lists the options to the imqsvcadmin command.
Table 13–16 Service Administrator Options
Option |
Description |
---|---|
-javahome path |
Location of alternative Java runtime Default behavior: Use runtime installed on system or bundled with Message Queue. |
-jrehome path | |
-vmargs arg1 [ [arg2] … ] |
Additional arguments to pass to Java Virtual Machine (JVM) running broker service [These arguments can also be specified in the Start Parameters field under the General tab in the service’s Properties window (reached via the Services tool in the Windows Administrative Tools control panel). ] Example: imqsvcadmin install -vmargs "-Xms16m -Xmx128m" |
-args arg1 [ [arg2] … ] |
Additional command line arguments to pass to broker service Example: imqsvcadmin install -args "-passfile d:\\imqpassfile" See Broker Utility for information about broker command line arguments. |
-h |
Display usage help [Any other options specified on the command line are ignored. ] |
Any information you specify using the -javahome, -vmargs, and -args options is stored in the Windows registry under the keys JREHome, JVMArgs, and ServiceArgs in the path
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\iMQ_Broker\Parameters
The Key Tool utility (imqkeytool) generates a self-signed certificate for the broker, which can be used for the ssljms, ssladmin, or cluster connection service. The syntax is
imqkeytool -broker
On UNIX systems, you may need to run the utility from the superuser (root) account.
This chapter provides reference information about configuration properties for a message broker. It consists of the following sections:
Table 14–1 lists the broker properties related to connection services.
Table 14–1 Broker Connection Properties
Property |
Type |
Default |
Description |
---|---|---|---|
String |
jms,admin |
List of connection services to be activated at broker startup, separated by commas |
|
String |
All available IP addresses |
Default host name or IP address for all connection services |
|
String |
None |
Host name or IP address of Port Mapper If specified, overrides imq.hostname. |
|
imq.portmapper.port [Can be used with imqcmd update bkr command] |
Integer |
7676 |
Port number of Port Mapper Note – If multiple broker instances are running on the same host, each must be assigned a unique Port Mapper port. |
imq.serviceName.protocolType.hostname [jms, ssljms, admin, and ssladmin services only; see Appendix C, HTTP/HTTPS Support for information on configuring the httpjms and httpsjms services] |
String |
None |
Host name or IP address for connection service If specified, overrides imq.hostname for the designated connection service. |
Integer |
0 |
Port number for connection service A value of 0 specifies that the port number should be allocated dynamically by the Port Mapper. |
|
Integer |
50 |
Maximum number of pending Port Mapper requests in operating system backlog |
|
imq.serviceName.threadpool_model [jms and admin services only] |
String |
dedicated |
Threading model for thread pool management: dedicated: Two dedicated threads per connection, one for incoming and one for outgoing messages shared: Connections processed by shared thread when sending or receiving messages |
The dedicated model limits the number of connections that can be supported, but provides higher performance; the shared model increases the number of possible connections, but at the cost of lower performance because of the additional overhead needed for thread management. |
|||
Integer |
jms: 10ssljms: 10httpjms: 10 httpsjms: 10 admin: 4ssladmin: 4 |
Minimum number of threads maintained in connection service’s thread pool When the number of available threads exceeds this threshold, threads will be shut down as they become free until the minimum is reached. The default value varies by connection service, as shown. |
|
Integer |
jms: 1000ssljms: 500httpjms: 500httpsjms : 500admin: 10ssladmin: 10 |
Number of threads beyond which no new threads are added to the thread pool for use by the named connection service Must be greater than 0 and greater than the value of imq.serviceName.min_threads. The default value varies by connection service, as shown. |
|
imq.shared.connectionMonitor_limit [Shared threading model only] |
Integer |
Solaris: 512Linux: 512Windows: 64 |
Maximum number of connections monitored by a distributor thread The system allocates enough distributor threads to monitor all connections. The smaller the value of this property, the faster threads can be assigned to active connections. A value of -1 denotes an unlimited number of connections per thread. The default value varies by operating-system platform, as shown. |
Integer |
120 |
Interval, in seconds, at which to test connection between client and broker A value of 0 or -1 disables periodic testing of the connection. |
Table 14–2 lists the broker properties related to routing services. Properties that configure the automatic creation of destinations are listed in Table 14–3.
Table 14–2 Broker Routing PropertiesTable 14–3 Broker Properties for Auto-Created Destinations
Message QueueTM supports both file-based and JDBC-based models for persistent data storage. The broker property imq.persist.store (Table 14–4) specifies which model to use. The following sections describe the broker configuration properties for the two models.
Table 14–4 Global Broker Persistence Property
Property |
Type |
Default |
Description |
---|---|---|---|
String |
file |
Model for persistent data storage: file: File-based persistence jdbc: JDBC-based persistence |
Table 14–5 lists the broker properties related to file-based persistence.
Table 14–5 Broker Properties for File-Based Persistence
Table 14–6 lists the broker properties related to JDBC-based persistence. Examples shown are for the PointBase® family of database products from DataMirror Mobile Solutions, Inc.
Table 14–6 Broker Properties for JDBC-Based Persistence
Table 14–7 lists the broker properties related to security services.
Table 14–7 Broker Security Properties
Property |
Type |
Default |
Description |
---|---|---|---|
Boolean |
true |
If true, the system will check the access control properties file to verify that an authenticated user is authorized to use a connection service or to perform specific operations with respect to specific destinations. |
|
imq.serviceName.accesscontrol.enabled |
Boolean |
None |
Use access control for connection service? If specified, overrides imq.accesscontrol.enabled for the designated connection service. If true, the system will check the access control properties file to verify that an authenticated user is authorized to use the designated connection service or to perform specific operations with respect to specific destinations. |
String |
accesscontrol.properties |
Name of access control properties file The file name specifies a path relative to the access control directory (see Appendix A, Platform-Specific Locations of Message QueueTM Data). |
|
String |
None |
Name of access control properties file for connection service If specified, overrides imq.accesscontrol.file.filename for the designated connection service. The file name specifies a path relative to the access control directory (see Appendix A, Platform-Specific Locations of Message QueueTM Data). |
|
String |
digest |
basic: Base-64 digest: MD5 |
|
String |
None |
Password encoding method for connection service: basic: Base-64 digest: MD5 If specified, overrides imq.authentication.type for the designated connection service. |
|
String |
file |
Type of user repository for base-64 authentication: file: File-based ldap: LDAP |
|
Integer |
180 |
Interval, in seconds, to wait for client response to authentication requests |
|
Boolean |
false |
Obtain passwords from password file? |
|
String |
See Appendix A, Platform-Specific Locations of Message QueueTM Data |
Path to directory containing password file |
|
String |
passfile | ||
String |
None |
Password for administrative user The Command utility (imqcmd) uses this password to authenticate the user before executing a command. |
|
String |
None |
Host name and port number for LDAP server The value is of the form hostName:port where hostName is the fully qualified DNS name of the host running the LDAP server and port is the port number used by the server. |
|
To specify a list of failover servers, use the following syntax: host1:port1 ldap://host2: port2 ldap://host3 :port3 … |
|||
Entries in the list are separated by spaces. Note that each failover server address is prefixed with ldap://. Use this format even if you use SSL and have set the property imq.user_repository.ldap.ssl.enabled to true. You need not specify ldaps in the address. |
|||
String |
None |
Distinguished name for binding to LDAP user repository Not needed if the LDAP server allows anonymous searches. |
|
imq.user_repository.ldap.password [Should be used only in password files] |
String |
None |
Password for binding to LDAP user repository Not needed if the LDAP server allows anonymous searches. |
To come |
To come |
To come |
|
String |
None |
Directory base for LDAP user entries |
|
String |
None |
Provider-specific attribute identifier for LDAP user name |
|
String |
None |
(Optional) JNDI filter for LDAP user searches |
|
Boolean |
false |
Enable LDAP group searches? Note – Message Queue does not support nested groups. |
|
String |
None |
Directory base for LDAP group entries |
|
String |
None |
Provider-specific attribute identifier for LDAP group name |
|
String |
None |
Provider-specific attribute identifier for user names in LDAP group |
|
String |
None |
(Optional) JNDI filter for LDAP group searches |
|
Integer |
280 |
Time limit for LDAP searches, in seconds |
|
Boolean |
false |
Use SSL when communicating with LDAP server? |
|
String |
See Appendix A, Platform-Specific Locations of Message QueueTM Data |
Path to directory containing key store file |
|
String |
keystore |
Name of key store file |
|
String |
None |
Password for key store file |
|
Boolean |
false |
Start audit logging to broker log file? |
Table 14–8 lists the broker properties related to monitoring services.
Table 14–8 Broker Monitoring Properties
Property |
Type |
Default |
Description |
---|---|---|---|
String |
INFO |
Logging level Specifies the categories of logging information that can be written to an output channel. Possible values, from high to low: ERROR WARNING INFO Each level includes those above it (for example, WARNING includes ERROR). |
|
Boolean |
false |
Log information about dead messages? If true, the following events will be logged:
|
|
imq.log.console.stream |
String |
ERR |
Destination for console output: OUT: stdout ERR: stderr |
String |
ERROR|WARNING |
Categories of logging information to write to console: NONE ERROR WARNING INFO ALL The ERROR, WARNING, and INFO categories do not include those above them, so each must be specified explicitly if desired. Any combination of categories can be specified, separated by vertical bars (|). |
|
String |
See Appendix A, Platform-Specific Locations of Message QueueTM Data |
Path to directory containing log file |
|
String |
log.txt |
Name of log file |
|
String |
ALL |
Categories of logging information to write to log file: NONE ERROR WARNING INFO ALL The ERROR, WARNING, and INFO categories do not include those above them, so each must be specified explicitly if desired. Any combination of categories can be specified, separated by vertical bars (|). |
|
Integer |
-1 |
File length, in bytes, at which output rolls over to a new log file A value of -1 denotes an unlimited number of bytes (no rollover based on file length). |
|
Integer |
604800 (one week) |
Age of file, in seconds, at which output rolls over to a new log file A value of -1 denotes an unlimited number of seconds (no rollover based on file age). |
|
String |
ERROR |
Categories of logging information to write to syslogd(1M): NONE ERROR WARNING INFO ALL The ERROR, WARNING, and INFO categories do not include those above them, so each must be specified explicitly if desired. Any combination of categories can be specified, separated by vertical bars (|). |
|
String |
LOG_DAEMON |
syslog facility for logging messages Possible values mirror those listed on the syslog(3C) man page. Appropriate values for use with Message Queue include: LOG_USER LOG_DAEMON LOG_LOCAL0 LOG_LOCAL1 LOG_LOCAL2 LOG_LOCAL3 LOG_LOCAL4 LOG_LOCAL5 LOG_LOCAL6 LOG_LOCAL7 |
|
String |
imqbrokerd_${imq.instanceName} |
Identity string to be prefixed to all messages logged to syslog |
|
Boolean |
true |
Log broker process ID with message? |
|
Boolean |
false |
Write messages to system console if they cannot be sent to syslog? |
|
String |
Local time zone |
Time zone for log time stamps Possible values are the same as those used by the method java.util.TimeZone.getTimeZone. Examples: GMT GMT-8:00 America/LosAngeles Europe/Rome Asia/Tokyo |
|
Boolean |
true |
Enable writing of metrics information to Logger? Does not affect the production of metrics messages (controlled by imq.metrics.topic.enabled). |
|
Integer |
-1 |
Time interval, in seconds, at which to write metrics information to Logger Does not affect the time interval for production of metrics messages (controlled by imq.metrics.topic.interval). A value of -1 denotes an indefinite interval (never write metrics information to Logger). |
|
Boolean |
true |
Enable production of metrics messages to metric topic destinations? If false, an attempt to subscribe to a metric topic destination will throw a client-side exception. |
|
Integer |
60 |
Time interval, in seconds, at which to produce metrics messages to metric topic destinations |
|
Boolean |
false |
Are metrics messages sent to metric topic destinations persistent? |
|
Integer |
300 |
Lifetime, in seconds, of metrics messages sent to metric topic destinations |
Table 14–9 lists the configuration properties related to broker clusters.
Table 14–9 Broker Properties for Cluster Configuration
Property |
Type |
Default |
Description |
---|---|---|---|
imq.cluster.brokerlist [Must have the same value for all brokers in a cluster] |
String |
None |
List of broker addresses The list consists of one or more addresses, separated by commas. Each address specifies the host name and Port Mapper port number of a broker in the cluster, in the form hostName:portNumber. Example: host1:3000,host2:8000,ctrlhost |
imq.cluster.hostname [Can be specified independently for each broker in a cluster] |
String |
None |
Host name or IP address for cluster connection service If specified, overrides imq.hostname (see Table 14–1) for the cluster connection service. |
Integer |
0 |
Port number for cluster connection service A value of 0 specifies that the port number should be allocated dynamically by the Port Mapper. |
|
String |
tcp |
Network transport protocol for cluster connection service For secure, encrypted message delivery between brokers, set this property to ssl. |
|
imq.cluster.url, [Can be used with imqcmd update bkr command] |
String |
None |
URL of cluster configuration file, if any Examples: http://webserver/imq/cluster.properties (for a file on a Web server) file:/net/mfsserver/imq/cluster.properties (for a file on a shared drive) |
String |
None |
Host name and port number of cluster’s master broker, if any The value has the form hostName:portNumber, where hostName is the host name of the master broker and portNumber is its Port Mapper port number. Example: ctrlhost:7676 |
Alphabetical List of Broker Properties is an alphabetical list of broker configuration properties, with cross-references to the relevant tables in this chapter.
Table 14–10 Alphabetical List of Broker Properties
Property |
Table |
---|---|
imq.persist.store | |
This chapter provides reference information about configuration properties for physical destinations. These properties can be set when creating or updating a physical destination. For auto-created destinations, you set default values in the broker’s instance configuration file (see Table 14–3).
This chapter provides reference information about the attributes of administered objects. It consists of the following sections:
The attributes of a connection factory object are grouped into categories described in the following sections below:
Table 16–1 lists the connection factory attributes for connection handling.
Table 16–1 Connection Factory Attributes for Connection Handling
Attribute |
Type |
Default |
Description |
---|---|---|---|
String |
An existing Message QueueTM 3.0 address, if any; if none, the first entry in Table 16–2 |
List of broker addresses The list consists of one or more broker addresses, separated by commas. Each address specifies (or implies) the host name, port number, and connection service for a broker instance to which the client can connect. Address syntax varies depending on the connection service and port assignment method; see below for details. |
|
String |
PRIORITY |
Order in which to attempt connection to broker addresses: PRIORITY: Order specified in address list RANDOM: Random order Note – If many clients share the same connection factory, specify random connection order to prevent them from all attempting to connect to the same address. |
|
Integer |
5 |
Number of times to iterate through address list attempting to establish or reestablish a connection A value of -1 denotes an unlimited number of iterations. |
|
imqPingInterval |
Integer |
30 |
Interval, in seconds, at which to test connection between client and broker A value of 0 or -1 disables periodic testing of the connection. |
Boolean |
false |
Attempt to reestablish a lost connection? |
|
Integer |
0 |
Number of times to attempt connection (or reconnection) to each address in address list before moving on to next A value of -1 denotes an unlimited number of connection attempts: attempt repeatedly to connect to first address until successful. |
|
Long integer |
3000 |
Interval, in milliseconds, between reconnection attempts This value applies both for successive attempts on a given address and for successive addresses in the list. Note – Too small a value may give the broker insufficient recovery time; too large a value may cause unacceptable connection delays. |
|
Boolean |
true |
Trust any certificate presented by broker? If false, the Message Queue client runtime will validate all certificates presented to it. Validation will fail if the signer of the certificate is not in the client's trust store. If true, validation of certificates is skipped. This can be useful, for instance, during software testing when a self-signed certificate is used. NOTE: To use signed certificates from a certification authority, set this attribute to false. |
The value of the imqAddressList attribute is a comma-separated string specifying one or more broker addresses to which to connect. The general syntax for each address is as follows:
scheme://address
where scheme identifies one of the addressing schemes shown in the first column of Table 16–2 and address denotes the broker address itself. The exact syntax for specifying the address depends on the addressing scheme, as shown in the last column of the table.
Table 16–2 Message Broker Addressing SchemesTable 16–3 Message Broker Address Examples
Service |
Broker Host |
Port |
Example Address |
---|---|---|---|
Not specified |
Not specified |
Not specified |
No address (mq://localHost:7676/jms) |
Not specified |
Specified host |
Not specified |
myBkrHost (mq://myBkrHost:7676/jms) |
Not specified |
Not specified |
Specified Port Mapper port |
1012 (mq://localHost:1012/jms) |
ssljms |
Local host |
Standard Port Mapper port |
mq://localHost:7676/ssljms |
ssljms |
Specified host |
Standard Port Mapper port |
mq://myBkrHost:7676/ssljms |
ssljms |
Specified host |
Specified Port Mapper port |
mq://myBkrHost:1012/ssljms |
jms |
Local host |
Specified service port |
mqtcp://localhost:1032/jms |
ssljms |
Specified host |
Specified service port |
mqssl://myBkrHost:1034/ssljms |
httpjms |
Not applicable |
Not applicable |
http://websrvr1:8085/imq/tunnel |
httpsjms |
Not applicable |
Not applicable |
https://websrvr2:8090/imq/tunnel |
Table 16–4 lists the connection factory attributes for client identification.
Table 16–4 Connection Factory Attributes for Client Identification
Attribute |
Type |
Default |
Description |
---|---|---|---|
String |
guest |
Default user name for authenticating with broker |
|
String |
guest |
Default password for authenticating with broker |
|
String |
null |
Administratively configured client identifier |
|
Boolean |
false |
Prevent client from changing client identifier using setClientID method? |
Table 16–5 lists the connection factory attributes for reliability and flow control.
Table 16–5 Connection Factory Attributes for Reliability and Flow Control
Attribute |
Type |
Default |
Description |
---|---|---|---|
String |
0 |
Maximum time, in milliseconds, to wait for broker acknowledgment before throwing an exception A value of 0 denotes no timeout (wait indefinitely). Note – In some situations, too low a value can cause premature timeout: for example, initial authentication of a user against an LDAP user repository using a secure (SSL) connection can take more than 30 seconds. |
|
Integer |
100 |
Number of payload messages in a metered batch Delivery of payload messages to the client is temporarily suspended after this number of messages, allowing any accumulated control messages to be delivered. Payload message delivery is resumed on notification by the client runtime, and continues until the count is again reached. A value of 0 disables metering of message delivery and may cause Message Queue control messages to be blocked by heavy payload message traffic. |
|
Boolean |
false |
Limit message flow at connection level? |
|
Integer |
1000 |
Maximum number of messages per connection to deliver and buffer for consumption Message delivery on a connection stops when the number of unconsumed payload messages pending (subject to flow metering governed by imqConnectionFlowCount) exceeds this limit. Delivery resumes only when the number of pending messages falls below the limit. This prevents the client from being overwhelmed with pending messages that might cause it to run out of memory. This attribute is ignored if imqConnectionFlowLimitEnabled is false. |
|
Integer |
100 |
Maximum number of messages per consumer to deliver and buffer for consumption Message delivery to a given consumer stops when the number of unconsumed payload messages pending for that consumer exceeds this limit. Delivery resumes only when the number of pending messages for the consumer falls below the percentage specified by imqConsumerFlowThreshold. This can be used to improve load balancing among multiple consumers and prevent any single consumer from starving others on the same connection. This limit can be overridden by a lower value set for a queue’s own consumerFlowLimit attribute (see Chapter 15, Physical Destination Property Reference). Note also that message delivery to all consumers on a connection is subject to the overall limit specified by imqConnectionFlowLimit. |
|
Integer |
50 |
Number of messages per consumer buffered in the client runtime, as a percentage of imqConsumerFlowLimit, below which to resume message delivery |
Table 16–6 lists the connection factory attributes for queue browsing and server sessions.
Table 16–6 Connection Factory Attributes for Queue Browser and Server Sessions
The connection factory attributes listed in Table 16–7 control whether the Message Queue client runtime sets certain standard message properties defined in the Java Message Service Specification.
Table 16–7 Connection Factory Attributes for Standard Message Properties
Property |
Type |
Default |
Description |
---|---|---|---|
Boolean |
false |
Set JMSXUserID property (identity of user sending message) for produced messages? |
|
Boolean |
false |
Set JMSXAppID property (identity of application sending message) for produced messages? |
|
Boolean |
false |
Set JMSXProducerTXID property (transaction identifier of transaction within which message was produced) for produced messages? |
|
Boolean |
false |
Set JMSXConsumerTXID property (transaction identifier of transaction within which message was consumed) for consumed messages? |
|
Boolean |
false |
Set JMSXRcvTimestamp property (time message delivered to consumer) for consumed messages? |
Table 16–8 lists the connection factory attributes for overriding JMS message header fields.
Table 16–8 Connection Factory Attributes for Message Header Overrides
Attribute |
Type |
Default |
Description |
---|---|---|---|
Boolean |
false |
Allow client-set delivery mode to be overridden? |
|
Integer |
2 |
Overriding value of delivery mode: 1 Nonpersistent 2 Persistent |
|
Boolean |
false |
Allow client-set expiration time to be overridden? |
|
Long integer |
0 |
Overriding value of expiration time, in milliseconds A value of 0 denotes an unlimited expiration time (message never expires). |
|
Boolean |
false |
Allow client-set priority level to be overridden? |
|
Integer |
4 (normal) |
Overriding value of priority level (0 to 9) |
|
Boolean |
false |
Apply overrides to temporary destinations? |
Table 16–9 lists the attributes that can be set for a destination administered object.
Table 16–9 Destination Attributes
Attribute |
Type |
Default |
Description |
---|---|---|---|
String |
Untitled_Destination_Object |
Name of physical destination The destination name may contain only alphanumeric characters (no spaces) and must begin with an alphabetic character or the underscore (_) or dollar sign ($) character. It may not begin with the characters mq. |
|
String |
None |
Descriptive string for destination |
Table 16–10 lists the attributes used to configure endpoint URLs for applications that use the Simple Object Access Protocol (SOAP); see the Message Queue Developer's Guide for Java Clients for more information.
Table 16–10 SOAP Endpoint Attributes
This chapter describes the configuration properties of the Message QueueTM JMS Resource Adapter (JMS RA), which enables you to integrate Sun Java SystemTM Message Queue with any J2EE 1.4 application server by means of the standard J2EE connector architecture (JCA). When plugged into an application server, the Resource Adapter allows applications deployed in that application server to use Message Queue to send and receive JMS messages.
The Message Queue JMS Resource Adapter exposes its configuration properties through three JavaBean components:
The ResourceAdapter JavaBean (ResourceAdapter JavaBean) affects the behavior of the Resource Adapter as a whole.
The ManagedConnectionFactory JavaBean (ManagedConnectionFactory JavaBean) affects connections created by the Resource Adapter for use by message-driven beans (MDBs).
The ActivationSpec JavaBean (ActivationSpec JavaBean) affects message endpoints that represent MDBs in their interactions with the messaging system.
To set property values for these entities, you use the tools provided by your application server for configuration and deployment of the Resource Adapter and for deployment of MDBs.
This chapter lists and describes the configuration properties of the Message Queue JMS Resource Adapter. It contains the following sections:
The ResourceAdapter configuration configures the default JMS Resource Adapter behavior. Table 17–1 lists and describes the properties with which you can configure this JavaBean.
Table 17–1 Resource Adapter Properties
A managed connection factory defines the connections that the Resource Adapter provides to a message-driven bean. Table 17–2 shows the properties of the ManagedConnectionFactory JavaBean; if set, these properties override the corresponding properties of the ResourceAdapter JavaBean.
Table 17–2 Managed Connection Factory Properties
Property |
Type |
Default |
Description |
---|---|---|---|
String |
Inherited from ResourceAdapter JavaBean (see Table 17–1) |
List of message service addresses for connecting to Message Queue service |
|
String |
guest |
(Optional) User name for connecting to Message Queue service |
|
String |
guest |
(Optional) Password for connecting to Message Queue service |
|
String |
None |
Client identifier for connections to Message Queue service |
|
String |
PRIORITY |
Order in which to attempt connection to Message Queue service: PRIORITY: Order specified in address list RANDOM: Random order Note – Reconnection attempts after a connection failure start with the broker whose connection failed and proceed sequentially through the address list, regardless of the value set for this property. |
|
Integer |
1 |
Number of times to iterate through address list attempting to establish or reestablish a connection |
|
Boolean |
false | ||
Integer |
6 |
Number of times to attempt reconnection to each address in address list before moving on to next |
|
Long integer |
30000 |
Interval, in milliseconds, between reconnection attempts |
Table 17–3 shows the configurable properties of the ActivationSpec JavaBean. These properties are used by the application server when instructing the Resource Adapter to activate a message endpoint and associate it with a message-driven bean.
Table 17–3 Activation Specification Properties
This chapter describes the metric information that a Message QueueTM message broker can provide for monitoring, tuning, and diagnostic purposes. This information can be made available in a variety of ways:
In a log file (see Sending Metrics Data to Log Files)
Via the Command utility’s metrics bkr command (see Broker Management)
In metrics messages sent to a metrics topic destination (see Writing an Application to Monitor Brokers)
The tables in this chapter list the kinds of metric information available and the forms in which it can be provided. For metrics provided through the Command utility’s metrics bkr command, the tables list the metric type with which they can be requested; for those provided in metrics messages, the tables list the metrics topic destination to which they are delivered. The chapter consists of the following sections:
Table 18–1 shows the metric information that the broker reports for the broker process JVM (Java Virtual Machine) heap.
Table 18–1 JVM Metrics
Metric Quantity |
Description |
Log File? |
metrics bkrMetricType |
Metrics Topic |
---|---|---|---|---|
JVM heap: total memory |
Current total memory, in bytes |
Yes |
cxn |
mq.metrics.jvm |
JVM heap: free memory |
Amount of memory currently available for use, in bytes |
Yes |
cxn |
mq.metrics.jvm |
JVM heap: max memory |
Maximum allowable heap size, in bytes |
Yes |
None |
mq.metrics.jvm |
Table 18–2 shows the brokerwide metric information that the broker reports.
Table 18–2 Brokerwide Metrics
Metric Quantity |
Description |
Log File? |
metrics bkrMetricType |
Metrics Topic |
---|---|---|---|---|
Connections |
||||
Num connections |
Total current number of connections for all connection services |
Yes |
cxn |
mq.metrics.broker |
Num threads |
Total current number of threads for all connection services |
Yes |
cxn |
None |
Min threads |
Total minimum number of threads for all connection services |
Yes |
cxn |
None |
Max threads |
Total maximum number of threads for all connection services |
Yes |
cxn |
None |
Stored Messages |
||||
Num messages |
Current number of payload messages stored in memory and persistent store |
No |
mq.metrics.broker |
|
Total message bytes |
Total size in bytes of payload messages currently stored in memory and persistent store |
No |
None |
mq.metrics.broker |
Message Flow |
||||
Num messages in |
Cumulative number of payload messages received since broker started |
Yes |
ttl |
mq.metrics.broker |
Num messages out |
Cumulative number of payload messages sent since broker started |
Yes |
ttl |
mq.metrics.broker |
Rate messages in |
Current rate of flow of payload messages into broker |
Yes |
rts |
None |
Rate messages out |
Current rate of flow of payload messages out of broker |
Yes |
rts |
None |
Message bytes in |
Cumulative size in bytes of payload messages received since broker started |
Yes |
ttl |
mq.metrics.broker |
Message bytes out |
Cumulative size in bytes of payload messages sent since broker started |
Yes |
ttl |
mq.metrics.broker |
Rate message bytes in |
Current rate of flow of payload message bytes into broker |
Yes |
rts |
None |
Rate message bytes out |
Current rate of flow of payload message bytes out of broker |
Yes |
rts |
None |
Num packets in |
Cumulative number of payload and control packets received since broker started |
Yes |
ttl |
mq.metrics.broker |
Num packets out |
Cumulative number of payload and control packets sent since broker started |
Yes |
ttl |
mq.metrics.broker |
Rate packets in |
Current rate of flow of payload and control packets into broker |
Yes |
rts |
None |
Rate packets out |
Current rate of flow of payload and control packets out of broker |
Yes |
rts |
None |
Packet bytes in |
Cumulative size in bytes of payload and control packets received since broker started |
Yes |
ttl |
mq.metrics.broker |
Packet bytes out |
Cumulative size in bytes of payload and control packets sent since broker started |
Yes |
ttl |
mq.metrics.broker |
Rate packet bytes in |
Current rate of flow of payload and control packet bytes into broker |
Yes |
rts |
None |
Rate packet bytes out |
Current rate of flow of payload and control packet bytes out of broker |
Yes |
rts |
None |
Destinations |
||||
Num destinations |
Current number of physical destinations |
No |
None |
mq.metrics.broker |
Table 18–3 shows the metric information that the broker reports for individual connection services.
Table 18–3 Connection Service Metrics
Metric Quantity |
Description |
Log File? |
metrics svcMetricType |
Metrics Topic |
---|---|---|---|---|
Connections |
||||
Num connections |
Current number of connections |
No |
None |
|
Num threads |
Current number of threads |
No |
cxn |
None |
Min threads |
Minimum number of threads assigned to service |
No |
cxn |
None |
Max threads |
Maximum number of threads assigned to service |
No |
cxn |
None |
Message Flow |
||||
Num messages in |
Cumulative number of payload messages received through connection service since broker started |
No |
ttl |
None |
Num messages out |
Cumulative number of payload messages sent through connection service since broker started |
No |
ttl |
None |
Rate messages in |
Current rate of flow of payload messages into broker through connection service |
No |
rts |
None |
Rate messages out |
Current rate of flow of payload messages out of broker through connection service |
No |
rts |
None |
Message bytes in |
Cumulative size in bytes of payload messages received through connection service since broker started |
No |
ttl |
None |
Message bytes out |
Cumulative size in bytes of payload messages sent through connection service since broker started |
No |
ttl |
None |
Rate message bytes in |
Current rate of flow of payload message bytes into broker through connection service |
No |
rts |
None |
Rate message bytes out |
Current rate of flow of payload message bytes out of broker through connection service |
No |
rts |
None |
Num packets in |
Cumulative number of payload and control packets received through connection service since broker started |
No |
ttl |
None |
Num packets out |
Cumulative number of payload and control packets sent through connection service since broker started |
No |
ttl |
None |
Rate packets in |
Current rate of flow of payload and control packets into broker through connection service |
No |
rts |
None |
Rate packets out |
Current rate of flow of payload and control packets out of broker through connection service |
No |
rts |
None |
Packet bytes in |
Cumulative size in bytes of payload and control packets received through connection service since broker started |
No |
ttl |
None |
Packet bytes out |
Cumulative size in bytes of payload and control packets sent through connection service since broker started |
No |
ttl |
None |
Rate packet bytes in |
Current rate of flow of payload and control packet bytes into broker through connection service |
No |
rts |
None |
Rate packet bytes out |
Current rate of flow of payload and control packet bytes out of broker through connection service |
No |
rts |
None |
Table 18–4 shows the metric information that the broker reports for individual destinations.
Table 18–4 Destination Metrics
Metric Quantity |
Description |
Log File? |
metrics dstMetricType |
Metrics Topic |
---|---|---|---|---|
Message Consumers |
||||
Num consumers |
Current number of associated message consumers For queue destinations, this attribute includes both active and backup consumers. For topic destinations, it includes both nondurable and (active and inactive) durable subscribers and is equivalent to “Num active consumers.” |
No |
con |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Peak num consumers |
Peak number of associated message consumers since broker started For queue destinations, this attribute includes both active and backup consumers. For topic destinations, it includes both nondurable and (active and inactive) durable subscribers and is equivalent to “Peak num active consumers.” |
No |
con |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Avg num consumers |
Average number of associated message consumers since broker started For queue destinations, this attribute includes both active and backup consumers. For topic destinations, it includes both nondurable and (active and inactive) durable subscribers and is equivalent to “Avg num active consumers.” |
No |
con |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Num active consumers |
Current number of associated active message consumers For topic destinations, this attribute includes both nondurable and (active and inactive) durable subscribers and is equivalent to “Num consumers.” |
No |
con |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Peak num active consumers |
Peak number of associated active message consumers since broker started For topic destinations, this attribute includes both nondurable and (active and inactive) durable subscribers and is equivalent to “Peak num consumers.” |
No |
con |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Avg num active consumers |
Average number of associated active message consumers since broker started For topic destinations, this attribute includes both nondurable and (active and inactive) durable subscribers and is equivalent to “Avg num consumers.” |
No |
con |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Current number of associated backup message consumers |
No |
con |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
|
Peak num backup consumers |
Peak number of associated backup message consumers since broker started |
No |
con |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Avg num backup consumers |
Average number of associated backup message consumers since broker started |
No |
con |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Stored Messages |
||||
Num messages |
Current number of messages stored in memory and persistent store |
No |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
|
Peak num messages |
Peak number of messages stored in memory and persistent store since broker started |
No |
conttlrts |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Avg num messages |
Average number of messages stored in memory and persistent store since broker started |
No |
conttlrts |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Total message bytes |
Current total size in bytes of messages stored in memory and persistent store |
No |
ttlrts |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Peak total message bytes |
Peak total size in bytes of messages stored in memory and persistent store since broker started |
No |
ttlrts |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Avg total message bytes |
Average total size in bytes of messages stored in memory and persistent store since broker started |
No |
ttlrts |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Message Flow |
||||
Num messages in |
Cumulative number of messages received since broker started |
No |
ttl |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Num messages out |
Cumulative number of messages sent since broker started |
No |
ttl |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Msg bytes in |
Cumulative size in bytes of messages received since broker started |
No |
ttl |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Msg bytes out |
Cumulative size in bytes of messages sent since broker started |
No |
ttl |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Peak message bytes |
Size in bytes of largest single message received since broker started |
No |
ttlrts |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Rate num messages in |
Current rate of flow of messages received |
No |
rts |
None |
Rate num messages out |
Current rate of flow of messages sent |
No |
rts |
None |
Rate msg bytes in |
Current rate of flow of message bytes received |
No |
rts |
None |
Rate msg bytes out |
Current rate of flow of message bytes sent |
No |
rts |
None |
Disk Utilization |
||||
Amount of disk space, in bytes, reserved for destination |
No |
dsk |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
|
Disk used |
Amount of disk space, in bytes, currently in use by destination |
No |
dsk |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |
Disk utilization ratio |
Ratio of disk space in use to disk space reserved for destination |
No |
dsk |
mq.metrics.destination.queue.queueNamemq.metrics.destination.topic.topicName |