Channel Information Service (com.ibi.agents.XDChanInfoAgent)

Syntax:

com.ibi.agents.XDChanInfoAgent

iIT Service Object:

operations: Server Statistics

Description:

This service returns an XML document that contains the current status information for the system. The service is also available for use in process flows. Each channel (represented by a master tag) is included in the XML output, along with statistics on its current state.

Properties:

Property

Description

Info

Root of the information tree.

Channels

The configured runtime channels.

Properties of statistics per channel (master)

name

Name of the channel. There is one master for each defined channel, regardless of its state.

state

State of the channel (active for started channel), runnable for deployed (not started) channel, stopping for the channel that is stopping.

  • Begin. Channel has been started, but has not yet completed the initialization.
  • Config. Errors were found during the initialization and the channel cannot start.
  • Retry. The channel initialization (or sometimes the execution phase) found a condition that is an error not related to the configuration. The channel can be automatically restarted at a later time.

failed

Number of times the channel execution failed.

completed

Number of times the channel execution completed.

active

Indicates whether the channel is active.

Properties of statistics per execution

user

User CPU time statistics.

cpu

CPU time statistics.

name

Name of the thread (required). Thread masters always have worker threads to execute messages.

Properties of statistics per transaction

variance

Variance of transaction time.

ehrlang

Ehrlang coefficient.

mean

Mean (average) time of transactions.

internalqs

Internal listeners are associated with queues. This section describes the queues themselves.

queue

The name of this queue. Usually this is the name of the internal listener that defines the queue (optional).

size

Number of messages waiting to be processed.

Edges:

The following table lists the available line edges for the Channel Information Service (com.ibi.agents.XDChanInfoAgent).

Line Edge

Description

OnError

Error

OnSuccess

Success

OnFailure

Failure

OnCustom

  • OnError
  • OnSuccess
  • OnFailure

Example:

The following is a sample of an XML document that is returned by the service:

<info>
 <channels>
  <master name="internal" state=" active " type="Internal" completed="0"
failed="0" active="0" available="1">
   <user mean="0.0" variance="0.0" ehrlang="1.0"/>
    <cpu mean="0.0" variance="0.0" ehrlang="1.0"/>
     <threads group="internal">
      <thread name="W.internal.1"/>
     </threads>
  </master>
  <master name="file1" state=" active " type="FILE" completed="0"
failed="0" active="0" available="4">
   <user mean="0.0" variance="0.0" ehrlang="1.0"/>
    <cpu mean="0.0" variance="0.0" ehrlang="1.0"/>
     <threads group="file1">
      <thread name="W.file1.1"/>
      <thread name="W.file1.2"/>
      <thread name="W.file1.3"/>
      <thread name="W.file1.4"/>
     </threads>
  </master>
 </channels>
 <internalqs>
  <queue name="internal1" size="0"/>
 </internalqs>
</info>