Adapter KPI Definitions

Edit online

The following table lists Adapter KPI definitions.

KPI Definition
wm.brokerdc.CustomAdapter
com.wm.isextdc.AdapterService
com.wm.artextdc.ARTConnection
com.wm.artextdc.ARTListener
com.wm.artextdc.ARTListenerNotification
com.wm.artextdc.ARTPollingNotification

wm.brokerdc.CustomAdapter

Edit online

A custom adapter is any Broker client that does not use the IBM webMethods Adapter Development Kit. A Custom Adapter component can be created for any Broker client.

Custom Adapter components are contained in Broker components.

Discovery Mechanism

Edit online

Auto-discovery via Broker.

KPIs

Edit online
The following table describes the wm.brokerdc.CustomAdapter KPIs.
Name Description
string AdapterType Type of resource to which the adapter is connected.
string Name Adapter system name.
string ApplicationName Application name for the adapter.
string ClientGroup Client group name.
struct ClientStats Statistics for the adapter's Broker client. Includes queue and document processing statistics.
date now Current time on the Broker host.
date createTime Time when the client was created.
Int cumulativeNumEventsDelivered Number of events delivered by this client.
Int cumulativeNumEventsPublished Total number of events published by this client.
Int cumulativeNumEventsRetrieved Number of events retrieved by this client.
int numEventsPublished Delta value of the number of events published by this client.
int numEventsDelivered Delta value of the number of events delivered by this client.
int numEventsRetrieved Delta value of the number of events retrieved by this client.
date lastEventPublishTime Time when the last event was published by this client.
date lastEventDeliveryTime Time when the last event was delivered by this client.
date lastEventQueueTime Time when the last event was queued for this client.
date lastEventRetrieveTime Time when the last event was retrieved by this client.
int queueLength Number of events in the client queue.
int queueByteSize Number of bytes worth of events in client queue.
date queueHighestLengthTime Time when QueueHighestLength was last set, Forever (zero date and time) if not yet queued.
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

com.wm.isextdc.AdapterService

Edit online

This interface defines KPIs for Integration Server adapter service components.

Discovery Mechanism

Edit online

Automatically discovered via Integration Server.

KPIs

Edit online
The following table describes the com.wm.isextdc.AdapterService KPIs.
Name Description
string UniversalNameLocalPart

Local part of the service universal name.

string UniversalNameNSPart

Namespace part of the service universal name.

boolean WebService

True if this is a Web service.

string SystemName

Service system name.

string Type

Output template type. Possible values are Java and Flow.

boolean Stateless

True for a stateless service.

string ACL

Access control list.

boolean EnforceInternalACL

True if ACLs are enforced for nested service invocations.

string OutputTemplate

Service output template file.

string TemplateType

Possible values areXML and HTML.

boolean Caching

True if caching is enabled.

boolean CachingPrefetch

True if caching prefetch is enabled.

int CachingExpiration

Result cache expiration interval, in seconds.

int PrefetchActivate

Cache prefetch for the service result.

long CurrentlyRunning

Current number of requests being processed.

long CumulativeRunTime

Cumulative run time for this service, in milliseconds.

long deltaCumulativeRunTime

Delta of the cumulative run time for this service, in milliseconds. This KPI reports the difference between the last two continuous poll readings of cumulativeRunTime.

long Count

Total number of service requests.

long deltaCount

Delta of the total number of service requests. This KPI reports the difference between the last two continuous poll readings of count.

long RetryCount

Number of the times the service failed and was retried.

long deltaRetryCount

Delta of the number of the times the service failed and was retried. This KPI reports the difference between the last two continuous poll readings of retryCount.

string JavaClass

Java class that implements this service.

string JavaMethod

Java method that implements this service.

date LastRan

Last time the service was invoked.

string LoadError

Last error loading the service.

long EMAILProtocolCumulativeRunTime

The cumulative run time for this service invoked by EMAIL Protocol.

long FTPProtocolCumulativeRunTime

The cumulative run time for this service invoked by FTP Protocol.

long HTTPProtocolCumulativeRunTime

The cumulative run time for this service invoked by HTTP Protocol.

long HTTPSProtocolCumulativeRunTime

The cumulative run time for this service invoked by HTTPS Protocol.

long SOAPProtocolCumulativeRunTime

The cumulative run time for this service invoked by SOAP Protocol.

long BROKERXPORTProtocolCumulativeRunTime

The cumulative run time for this service invoked by Broker Transport Protocol.

long EMAILProtocolNumInvokes

The number of times this service has been invoked by EMAIL protocol.

long FTPProtocolNumInvokes

The number of times this service has been invoked by FTP protocol.

long HTTPProtocolNumInvokes

The number of times this service has been invoked by HTTP protocol.

long HTTPSProtocolNumInvokes

The number of times this service has been invoked by HTTPS protocol.

long SOAPProtocolNumInvokes

The number of times this service has been invoked by SOAP protocol.

long BROKERXPORTProtocolNumInvokes

The number of times this service has been invoked by Broker Transport protocol.

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

com.wm.artextdc.ARTConnection

Edit online

The ART Connection component monitors a configured connection of an adapter instance to a resource instance.

Discovery Mechanism

Edit online

Auto-discovered with discovery of IS.

KPIs

Edit online
The following table describes the com.wm.artextdc.ARTConnection KPIs.
Name Description
string AdapterType Locale-sensitive information about the type of adapter used by this connection.
int TotalConnections Total number of connections existing currently in a pool for the resource (busy connections and free connections).
int BusyConnections Number of connections currently in use by adapter instances.
int FreeConnections Number of connections currently available.
long CompletionCount Number of successful connections to the resource.
long deltaCompletionCount Delta of the number of successful connections to the resource. This KPI reports the difference between the last two continuous poll readings of completionCount.
long FailureCount Number of failed connections to the resource.
long deltaFailureCount Delta of the number of failed connections to the resource. This KPI reports the difference between the last two continuous poll readings of failureCount.
string ConnectionType Locale-sensitive name for adapter connection type.
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.
boolean ResourceConnectionStatus Indicates Operational or Failed status of a connection to a resource.
boolean ResourceConnectionError Indicates whether an error was detected in between poll cycles.
int MessageSeverity Severity level of the resource message:

Critical = 1

Major = 2

Minor = 3

Warning = 4

Info = 5

Ok = 6

Indeterminate = 7

com.wm.artextdc.ARTListener

Edit online

ART Listeners are configured to handle data pushed from a resource to an Integration Server.

Discovery Mechanism

Edit online

Automatic discovery when Integration Server is discovered.

KPIs

Edit online
The following table describes the com.wm.artextdc.ARTListener KPIs.
Name Description
string ConnectionName Locale-sensitive name for the connection the listener uses to connect to the resource for polling.
date CreationDate When the listener was created.
long ExecutionCount Total number of times the notification has been executed.
long deltaExecutionCount Delta of the total number of times the notification has been executed. This KPI reports the difference between the last two continuous poll readings of executionCount.
long ExecutionTime Sum time of all notification executions that have occurred.
long FailureCount Number of failed executions.
long deltaFailureCount Delta of the number of failed executions. This KPI reports the difference between the last two continuous poll readings of failureCount.
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

com.wm.artextdc.ARTListenerNotification

Edit online

ART Listener notifications are configured to handle events from a resource.

Discovery Mechanism

Edit online

Automatic discovery when Integration Server is managed.

KPIs

Edit online
The following table describes the com.wm.artextdc.ARTListenerNotification KPIs.
Name Description
double AverageNotificationTime Average running time (totalTime/count).
long CompletionCount Number of successful notifications.
long deltaCompletionCount Delta of the umber of successful notifications. This KPI reports the difference between the last two continuous poll readings of completionCount.
long ConsecutiveCompletions Number of consecutive completions without a failure.
long deltaConsecutiveCompletions Delta of the number of consecutive completions without a failure. This KPI reports the difference between the last two continuous poll readings of consecutiveCompletions.
long ConsecutiveFailures Number of consecutive completions without a successful completion.
long deltaConsecutiveFailures Delta of the number of consecutive completions without a successful completion. This KPI reports the difference between the last two continuous poll readings of consecutiveFailures.
date CreationDate Creation date for the listener notification.
long FailureCount Number of failed notifications.
long deltaFailureCount Delta of the number of failed notifications. This KPI reports the difference between the last two continuous poll readings of failureCount.
string ListenerName Locale-sensitive information about the listener with which this notification is associated.
long NotificationCount Total number of times the listener notification has been executed.
long deltaNotificationCount Delta of the total number of times the listener notification has been executed. This KPI reports the difference between the last two continuous poll readings of notificationCount.
string NotificationType Listener notification type (synchronous or asynchronous).
string PublishableDocumentName Name of the document the asynchronous listener notification publishes.
string RequestDocumentName Name of the document associated with listener notification that is input to service.
string ReplyDocumentName Name of the document associated with service output.
string ServiceName TotalNotificationTime divided by NotificationCount.
long TotalNotificationTime Total number of milliseconds a notification has been running.
long deltaTotalNotificationTime Delta of the total number of milliseconds a notification has been running. This KPI reports the difference between the last two continuous poll readings of totalNotificationTime.
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

com.wm.artextdc.ARTPollingNotification

Edit online

ART Polling notifications use connections to poll the resource.

Discovery Mechanism

Edit online

Automatically discovered via Integration Server.

KPIs

Edit online
The following table describes the com.wm.artextdc.ARTPollingNotification KPIs.
Name Description
string ConnectionName Locale-sensitive name for the connection the polling notification uses to connect to the resource for polling.
string PollingInterval Interval at which to poll the resource.
boolean PollingOverlap Whether to configure polling notifications to overlap.
boolean PollingImmediate Polling configured to start immediately after notification is enabled.
date CreationDate Duration of polling notification has been running.
long NotificationCount Total number of times the polling notification has been executed.
long deltaNotificationCount Delta of the total number of times the polling notification has been executed. This KPI reports the difference between the last two continuous poll readings of notificationCount.
long CompletionCount Number of successful invocations.
long deltaCompletionCount Delta of the number of successful invocations. This KPI reports the difference between the last two continuous poll readings of completionCount.
long FailureCount Number of failed invocations.
long deltaFailureCount Delta of the number of failed invocations. This KPI reports the difference between the last two continuous poll readings of failureCount.
long ConsecutiveCompletions Number of consecutive completions without a failure.
long deltaConsecutiveCompletions Delta of the number of consecutive completions without a failure. This KPI reports the difference between the last two continuous poll readings of consecutiveCompletions.
long ConsecutiveFailures Number of consecutive failures without a successful completion.
long deltaConsecutiveFailures Delta of the number of consecutive failures without a successful completion. This KPI reports the difference between the last two continuous poll readings of consecutiveFailures.
long TotalNotificationTime Total number of milliseconds a notification has been running.
long deltaTotalNotificationTime Delta of the total number of milliseconds a notification has been running. This KPI reports the difference between the last two continuous poll readings of totalNotificationTime.
double AverageNotificationTime TotalNotificationTime divided by NotificationCount.
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