JES Monitoring Framework Reference

22 JES Monitoring Framework Reference

This chapter describes the monitoring information items that Message Queue exposes through the Sun Java Enterprise System Monitoring Framework (JESMF), using the Monitoring Framework’s Common Monitoring Model (CMM). It contains the following sections:

Common Attributes
Message Queue Product Information
Broker Information
Port Mapper Information
Connection Service Information
Destination Information
Persistent Store Information
User Repository Information

Common Attributes

The attributes listed in Table 22-1 are common to all (or almost all) CMM objects.

Table 22-1 JESMF Common Object Attributes

Attribute Description

Attribute	Description
`Name`	Object name
`Caption`	Short description
`Description`	Full description
`LastUpdateTime`	Time last updated
`OperationalStatus`	Current status (for example, `OK` or `DORMANT`)
`StatusDescriptions`	Description of status
`OperationalStatusLastChange`	Time of last change in operational status

Name

Object name

Caption

Short description

Description

Full description

LastUpdateTime

Time last updated

OperationalStatus

Current status (for example, OK or DORMANT)

StatusDescriptions

Description of status

OperationalStatusLastChange

Time of last change in operational status

Message Queue Product Information

Table 22-2 shows attributes of the Message Queue product itself that can be accessed with JESMF.

Table 22-2 JESMF-Accessible Message Queue Product Attributes

Attribute Description

Attribute	Description
`ProductName`	Product name
`ProductIdentifyingNumber`	Identifying number of product, in the form urn`:`uuid`:`xxxxxxxx`-`xxxx`-`xxxx`-`xxxx`-`xxxxxxxxxxxx Value changes for every version.
`ProductVendor`	Vendor name
`ProductVersion`	Version number
`RevisionNumber`	Revision number
`BuildNumber`	Build number
`PatchID`	Patch identifier (if any)
`CollectionID`	Identification key for installed product object Differentiates among product installations; usually identifies the installation location.
`InstallDate`	Installation date

ProductName

Product name

ProductIdentifyingNumber

Identifying number of product, in the form

urn`:uuid:xxxxxxxx-xxxx-xxxx-xxxx-`xxxxxxxxxxxx

Value changes for every version.

ProductVendor

Vendor name

ProductVersion

Version number

RevisionNumber

Revision number

BuildNumber

Build number

PatchID

Patch identifier (if any)

CollectionID

Identification key for installed product object

Differentiates among product installations; usually identifies the installation location.

InstallDate

Installation date

Broker Information

Table 22-3 shows the JESMF -accessible attributes pertaining to each broker instance.

Table 22-3 JESMF-Accessible Message Queue Broker Attributes

Attribute Description

Attribute	Description
`PrimaryOwnerName`	Name of primary system owner (broker property `imq.primaryowner.name`; see Table 17-13)
`PrimaryOwnerContact`	Contact information for primary system owner (broker property `imq.primaryowner.contact`; see Table 17-13)
`Roles`	Array of strings denoting broker’s roles (taken from broker properties `imq.broker.adminDefinedRoles.name`n; see Table 17-13)
`StartupTime`	Time of last startup (date and time in milliseconds)
`URL`	URL of Port Mapper
`ConfigurationDirectory`	Broker instance directory (for example, `/var/imq/instances/mybroker`)
`DirectoryName`	Distinguished name of directory (for example, LDAP) entry where static information about application is stored An empty string indicates that no information about the application is available in the directory.

PrimaryOwnerName

Name of primary system owner (broker property imq.primaryowner.name; see Table 17-13)

PrimaryOwnerContact

Contact information for primary system owner (broker property imq.primaryowner.contact; see Table 17-13)

Roles

Array of strings denoting broker’s roles (taken from broker properties `imq.broker.adminDefinedRoles.name`n; see Table 17-13)

StartupTime

Time of last startup (date and time in milliseconds)

URL

URL of Port Mapper

ConfigurationDirectory

Broker instance directory (for example, /var/imq/instances/mybroker)

DirectoryName

Distinguished name of directory (for example, LDAP) entry where static information about application is stored

An empty string indicates that no information about the application is available in the directory.

Port Mapper Information

The attributes shown in Table 22-4 provide information about a broker’s Port Mapper.

Table 22-4 JESMF-Accessible Message Queue Port Mapper Attributes

Attribute Description

Attribute	Description
`LabeledURI`	URI for accessing Port Mapper, in the form `mq://`hostName:portNumber
`Secured`	Is Port Mapper access secure (SSL/TLS)?

LabeledURI

URI for accessing Port Mapper, in the form

`mq://`hostName:portNumber

Secured

Is Port Mapper access secure (SSL/TLS)?

Connection Service Information

Table 22-5 shows the JESMF -accessible attributes pertaining to each connection service.

Table 22-5 JESMF-Accessible Message Queue Connection Service Attributes

Attribute Description

Attribute	Description
`LabeledURI`	URI for accessing connection service, in the form mq://`hostName:`portNumber`/`serviceName if dynamically allocated, or mqtcp://`hostName:`servicePort`/`serviceName or mqssl://`hostName:`servicePort`/`serviceName if statically assigned
`Secured`	Is connection service access secure (SSL/TLS)?
`ConnectionsCount`	Current number of connections
`NumConnectionsCreated`	Cumulative number of connections created since broker started
`FailedConnectionsCount`	Cumulative number of connections rejected since broker started
`CurrentNumberOfThreads`	Current number of threads actively handling connections
`MinThreadPoolSize`	Minimum number of threads maintained in connection service’s thread pool (broker property imq.`serviceName.min_threads`; see Table 17-1)
`MaxThreadPoolSize`	Number of threads beyond which no new threads are added to thread pool for use by connection service (broker property imq.`serviceName.max_threads`; see Table 17-1)
`NumProducers`	Current number of message producers
`NumConsumers`	Current number of message consumers
`NumMsgsIn`	Cumulative number of messages received since broker started
`NumMsgsOut`	Cumulative number of messages sent since broker started
`InBytesCount`	Cumulative size in bytes of messages received since broker started
`OutBytesCount`	Cumulative size in bytes of messages sent since broker started
`NumPktsIn`	Cumulative number of packets received since broker started
`NumPktsOut`	Cumulative number of packets sent since broker started
`PktBytesIn`	Cumulative size in bytes of packets received since broker started
`PktBytesOut`	Cumulative size in bytes of packets sent since broker started

LabeledURI

URI for accessing connection service, in the form

mq://`hostName:portNumber/`serviceName

if dynamically allocated, or

mqtcp://`hostName:servicePort/`serviceName

mqssl://`hostName:servicePort/`serviceName

if statically assigned

Secured

Is connection service access secure (SSL/TLS)?

ConnectionsCount

Current number of connections

NumConnectionsCreated

Cumulative number of connections created since broker started

FailedConnectionsCount

Cumulative number of connections rejected since broker started

CurrentNumberOfThreads

Current number of threads actively handling connections

MinThreadPoolSize

Minimum number of threads maintained in connection service’s thread pool (broker property imq.`serviceName.min_threads`; see Table 17-1)

MaxThreadPoolSize

Number of threads beyond which no new threads are added to thread pool for use by connection service (broker property imq.`serviceName.max_threads`; see Table 17-1)

NumProducers

Current number of message producers

NumConsumers

Current number of message consumers

NumMsgsIn

Cumulative number of messages received since broker started

NumMsgsOut

Cumulative number of messages sent since broker started

InBytesCount

Cumulative size in bytes of messages received since broker started

OutBytesCount

Cumulative size in bytes of messages sent since broker started

NumPktsIn

Cumulative number of packets received since broker started

NumPktsOut

Cumulative number of packets sent since broker started

PktBytesIn

Cumulative size in bytes of packets received since broker started

PktBytesOut

Cumulative size in bytes of packets sent since broker started

Destination Information

Table 22-6 shows the JESMF -accessible attributes pertaining to each destination. Each of these attributes corresponds to a Message Queue physical destination property; see Table 18-1 for further information.

Table 22-6 JESMF-Accessible Message Queue Destination Attributes

Attribute Corresponding Property Description

Attribute	Corresponding Property	Description
`Type`	+	Destination type (`q` = queue, `t` = topic)
`MaxNumMsgs`	`maxNumMsgs`	Maximum number of unconsumed messages
`MaxBytesPerMsg`	`maxBytesPerMsg`	Maximum size, in bytes, of any single message
`MaxTotalMsgBytes`	`maxTotalMsgBytes`	Maximum total memory, in bytes, for unconsumed messages
`LimitBehavior`	`limitBehavior`	Broker behavior when memory-limit threshold reached
`MaxNumProducers`^Foot 1	`maxNumProducers`	Maximum number of associated message producers
`MaxNumActiveConsumers`^Foot 2	`maxNumActiveConsumers`	Maximum number of associated active message consumers in load-balanced delivery
`MaxNumBackupConsumers`^Footref 2	`maxNumBackupConsumers`	Maximum number of associated backup message consumers in load-balanced delivery
`ConsumerFlowLimit`	`consumerFlowLimit`	Maximum number of messages delivered to consumer in a single batch
`LocalOnly`^Footref 1	`isLocalOnly`	Local delivery only?
`LocalDeliveryPreferred`^Footref 1 ^,^Footref 2	`localDeliveryPreferred`	Local delivery preferred?
`UseDMQ`^Footref 1	`useDMQ`	Send dead messages to dead message queue?

Type

Destination type (q = queue, t = topic)

MaxNumMsgs

maxNumMsgs

Maximum number of unconsumed messages

MaxBytesPerMsg

maxBytesPerMsg

Maximum size, in bytes, of any single message

MaxTotalMsgBytes

maxTotalMsgBytes

Maximum total memory, in bytes, for unconsumed messages

LimitBehavior

limitBehavior

Broker behavior when memory-limit threshold reached

`MaxNumProducers`^Foot 1

maxNumProducers

Maximum number of associated message producers

`MaxNumActiveConsumers`^Foot 2

maxNumActiveConsumers

Maximum number of associated active message consumers in load-balanced delivery

`MaxNumBackupConsumers`^Footref 2

maxNumBackupConsumers

Maximum number of associated backup message consumers in load-balanced delivery

ConsumerFlowLimit

consumerFlowLimit

Maximum number of messages delivered to consumer in a single batch

`LocalOnly`^Footref 1

isLocalOnly

Local delivery only?

`LocalDeliveryPreferred`^Footref 1 ^,^Footref 2

localDeliveryPreferred

Local delivery preferred?

`UseDMQ`^Footref 1

useDMQ

Send dead messages to dead message queue?

^Footnote 1Does not apply to dead message queue

^Footnote 2Queue destinations only

Persistent Store Information

The attributes shown in Table 22-7 pertain to the persistent data store.

Table 22-7 JESMF-Accessible Message Queue Persistent Store Attributes

Attribute Description

Attribute	Description
`AccessInfo`	URL for accessing JDBC database
`InfoFormat`	Format of `AccessInfo` attribute (`URL`)
`JDBCDriver`	JDBC driver
`UserName`	User name for authentication

AccessInfo

URL for accessing JDBC database

InfoFormat

Format of AccessInfo attribute (URL)

JDBCDriver

JDBC driver

UserName

User name for authentication

User Repository Information

The attributes shown in Table 22-8 pertain to the LDAP user repository.

Table 22-8 JESMF-Accessible Message Queue User Repository Attributes

Attribute Description

Attribute	Description
`AccessInfo`	URL for accessing LDAP server
`InfoFormat`	Format of `AccessInfo` attribute (`URL`)
`Base`	Root or base node for user lookup
`GroupBase`	Root or base node for group lookup
`UserName`	User name for authentication

AccessInfo

URL for accessing LDAP server

InfoFormat

Format of AccessInfo attribute (URL)

Base

Root or base node for user lookup

GroupBase

Root or base node for group lookup

UserName

User name for authentication