Broker KPI Definitions

Edit online

The following table lists IBM webMethods Broker KPI definitions.

KPI Definition
wm.brokerdc.BrokerServer
wm.brokerdc.Broker
wm.brokerdc.DocumentType
Note: All delta KPIs report the difference between the last two continuous poll readings of their corresponding KPI.

wm.brokerdc.BrokerServer

Edit online

The Broker Server is a process that hosts one or more Brokers. It provides storage and a runtime environment for the Brokers.

KPIs can be found on the Analytics Overview page, listed under the Broker Server host and port.

Discovery Mechanism

Edit online

Broker Servers are discovered via Asset Discovery and Network Discovery in Optimize.

KPIs

Edit online
The following table describes the wm.brokerdc.BrokerServer KPIs.
Name and Description Description
string LicenseKey

Broker Server software license key.

string DataDirectory

Directory where the Broker Server stores data.

string VersionString

Complete version string of the Broker Server software.

string SSLStatus.status

Current status of Secure Socket Layer (SSL) usage. Possible values are ENABLED, DISABLED, ERROR, NOTSUPPORTED.

string SSLStatus.encryption_level

Level of SSL encryption available. Possible values are NONE, US Domestic, US Export.

string SSLStatus.error_string

Description of the last error encountered starting SSL.

date ServerStats.now

Current time on the Broker Server.

date ServerStats.createTime

Time when the Broker Server was first started.

date ServerStats.serverStartTime

Time when the Broker Server was most recently started.

int ServerStats.numConnections

Current number of non-SSL connections.

int ServerStats.numSSLConnections

Current number of SSL connections.


int
ServerStats.highestNumConnections

Highest number of non-SSL connections since the last time the Broker Server was started.


int
ServerStats.highestNumSSLConnec
tions

Highest number of SSL connections since the last time the Broker Server was started.

date ServerStats.highestNumConnectionsTime

Time when HighestNumConnections last changed.

date ServerStats.highestNumSSLConnectionsTime

Time when highest NumSSLConnections last changed.

int ServerStats.licensedConnections

Licensed number of total SSL and non-SSL connections.-1 if not limited.

int ServerStats.licensedSSLConnections

Licensed number of SSL connections. -1 if not limited.

boolean ServerStats. isLicenseExpiringSoon

True if expiring within a week.

boolean ServerStats.isLicenseExpired

True if expired already.

date ServerStats.licenseExpirationTime

When the license expires.

int ServerStats.licenseRemaining

Number of seconds until license expires.

boolean ServerStats.isDiskSpaceLow

True if disk free < 1MB.

boolean ServerStats.isDiskSpaceVeryLow

True if disk free < 100KB.

double SystemStats.userTimeUsed

Number of seconds (or fractions thereof) of CPU user time used by the Broker since it started.

double SystemStats.systemTimeUsed

Number of seconds (or fractions thereof) of CPU system time used by the Broker since it started.

long SystemStats.guaranteedSpaceUsed

Number of KB the guaranteed storage is using on the disk.

long SystemStats.guaranteedSpaceReserved

Number of KB the reserved for guaranteed storage on the disk. If zero, storage will be resized as needed. If non-zero, storage will be fixed at this size.

long SystemStats.guaranteedSpaceMax

Maximum number of KB the guaranteed storage can grow to due to system limits, if disk space or reservation limits are not hit first.

long SystemStats.guaranteedDiskSize

Size of the guaranteed store disk in KB.

long SystemStats.guaranteedSpaceAllocated

Disk space allocated for guaranteed storage.

long SystemStats.guaranteedDiskFree

Amount of free space on the disk in KB.

string SystemStats.guaranteedDiskName

Name of the guaranteed disk partition.

long SystemStats.persistentSpaceUsed

Number of KB the persistent storage is using on the disk.

date SystemStats.now

Current time on the Broker Server.

long SystemStats.persistentSpaceMax

Maximum number of KB the persistent storage can grow to due to system limits, if disk space or reservation limits are not hit first.

long SystemStats.persistentDiskSize

Size of the persistent store disk in KB.

long SystemStats.persistentDiskFree

Amount of free space on the disk in KB.

string SystemStats.persistentDiskName

Name of the persistent disk partition.

long SystemStats.persistentSpaceAllocated

Disk space allocated for persistent storage.

long SystemStats.swapSpaceFree

Number of KB of free swap space.

long SystemStats.swapSpaceMax

Total number of KB of swap space.

long StorageStats.configCurrentKbytesInuse

Current storage size in use in the Config store (Kb, long).

long StorageStats.configCurrentKbytesReserved

Current storage size reserved in the Config store (Kb, long).

long StorageStats.configMaxKbytesAvailable

Maximum storage size available in the Config store (Kb, long).

long StorageStats.dataCurrentKbytesInuse

Current storage size in use in the Data store (Kb, long).

long StorageStats.dataCurrentKbytesReserved

Current storage size reserved in the Data store (Kb, long).

long StorageStats.dataMaxKbytesAvailable

Maximum storage size available in the Data store (Kb, long).

long StorageStats.sessions

The length of the structure array describing statistics of each of the storage files used.

int ObjectStatus

Indicates Operational or Failed status of the component.

boolean ContainsResourceMessage

Flag indicating a resource message, such as a log message or exception message, has been received from the monitored resource.

int MessageSeverity
Severity level of the resource message:
  • Critical = 1
  • Major = 2
  • Minor = 3
  • Warning = 4
  • Info = 5
  • Ok = 6
  • Indeterminate = 7
int CurrentNoOfPollEventsSent The count of events sent for an asset during each polling.
int PollTime Polling time for an asset during each polling.
int PingTime Time to ping an asset server.

wm.brokerdc.Broker

Edit online

The Broker coordinates the exchange of documents between adapters and other client programs.

Broker components are contained in Broker Server components. A Broker can contain Custom Adapter and Document Type components.

Discovery Mechanism

Edit online

Brokers are discovered automatically from a Broker Server.

KPIs

Edit online
The following table describes the wm.brokerdc.Broker KPIs.
Name Description
string BrokerName

Broker name.

date BrokerStats.now

Current time on the Broker.

date BrokerStats.createTime

Time when the Broker was created.

int BrokerStats.cumulativeNumEventsDelivered

Total number of events (documents) delivered by all clients.

int BrokerStats.cumulativeNumEventsPublished

Total number of events (documents) published by all clients.

int BrokerStats.cumulativeNumEventsQueued

Total number of events (documents) placed in client queues.

int BrokerStats.numEventsDelivered

Delta value of number of events (documents) delivered by all clients.

int BrokerStats.numEventsPublished

Delta value of number of events (documents) published by all clients.

int BrokerStats.numEventsQueued

Delta value of number of events (documents) placed in the queue.

int BrokerStats.numClients

Number of clients on the Broker, whether connected or not.

int BrokerStats.numEventTypes

Number of event types (document types) installed.

int BrokerStats.numTracesPublished

Number of trace events (documents) published by the Broker.

int BrokerStats.retryQueueMaxPublishes

Maximum simultaneous publish operations allowed by the retry queue.

int BrokerStats.retryQueueMaxEvents

Maximum events allowed in the retry queue.

int BrokerStats.retryQueueCurrentPublishes

Number of publish operations in the retry queue.

int BrokerStats.retryQueueCurrentEvents

Number of events in the retry queue.

int BrokerStats.retryQueueNextOpSequenceNum

Number of publish operations that required retries.

int BrokerStats.retryQueueNumberOfAttempts

Number of attempts to publish events in the retry queue.

int BrokerStats.retryQueueReservedTotalPublishes

Number of active publish operations.

int BrokerStats.retryQueueReservedGuaranteedPublishes

Number of active publish operations involving guaranteed events.

int BrokerStats.retryQueueReservedVolatilePublishes

Number of active publish operations involving only volatile events.

int BrokerStats.retryQueueReservedGuaranteedEvents

Number of guaranteed events in the active publish operations.

int BrokerStats.retryQueueReservedVolatileEvents

Number of volatile events in the active publish operations.

int BrokerStats.traceNumEventsQueued

Number of trace and activity events published.

date BrokerStats.traceLastEventEnqueueTime

Last time a trace or activity event was published.

long BrokerStats.traceQueueLength

Length of the trace event queue.

long BrokerStats.traceQueueByteSize

Size of the trace event queue.

long BrokerStats.traceQueueHighestLength

Peak length of the trace event queue.

date BrokerStats.traceQueueHighestLengthTime

Time the trace event queue reached its peak length.

BrokerStats.brokerThroughput

Throughput delta since the last poll.

BrokerStats.brokerCumulativeThroughput

Total throughput since the server started.

QueueStats.stalledQueues

Total number of stalled queues. A queue is stalled if the queue length is greater than 0 and no doc is retrieved for half an hour. A queue is also stalled if the queue length is greater than 0 and the last retrieved is newer.

QueueStats.noOfQueues

Count of all queues in the Broker.

int ObjectStatus

Indicates Operational or Failed status of the component.

boolean ContainsResourceMessage

Flag indicating a resource message, such as a log message or exception message, has been received from the monitored resource.

int MessageSeverity
Severity level of the resource message:

  • Critical = 1

  • Major = 2
  • Minor = 3
  • Warning = 4
  • Info = 5
  • Ok = 6
  • Indeterminate = 7

wm.brokerdc.DocumentType

Edit online

A document type is a definition of messages that travel over a network from a publisher to a subscriber, through the Broker. Document type components are created for all document types not used by the system.

Document type components are contained in Broker components.

Discovery Mechanism

Edit online

Document types are discovered automatically by Broker.

KPIs

Edit online
The following table describes the wm.brokerdc.DocumentType KPIs.
Name Description
date CreateTime

Time when the document type was created.

date LastDocumentDeliveryTime

Time when last document of this type was delivered.

date LastDocumentPublishTime

Time when last document of this type was published.

date LastForwardReceiveTime

Time when last document of this type was received via forwarding from another Broker.

int NumClientSubscriptions

Number of client subscriptions open which include this document type.

int NumEventsDelivered

Number of documents of this type delivered.

int NumEventsPublished

Number of documents of this type published.

int NumForwardsReceived

Number of documents of this type received via forwarding from another Broker.

date UpdateTime

Time when the document type was last changed.

int ObjectStatus

Indicates Operational or Failed status of the component.

boolean ContainsResourceMessage

Flag indicating a resource message, such as a log message or exception message, has been received from the monitored resource.

int MessageSeverity
Severity level of the resource message:
  • Critical = 1
  • Major = 2
  • Minor = 3
  • Warning = 4
  • Info = 5
  • Ok = 6
  • Indeterminate = 7