BWCEHawkMicroagent: Microagent Methods

Hawk agent uses BWCEHawkMicroagent to collect information from the TIBCO BusinessWorks Container Edition applications and operate using that information. BWCEHawkMicroagent runs specific tasks known as methods. Methods collect information and perform tasks. They can be called directly or from within a Hawk rulebase.

This section provides a complete list of all the available methods for BWCEHawkMicroagent.

Method Type

Hawk microagent methods are classified by the functions they perform and can be of the following types:

  • IMPACT_INFO: Returns information
  • IMPACT_ACTION: Performs an action on the TIBCO Hawk system
  • IMPACT_ACTION_INFO: Returns information and takes an action based on it

Method Output

Methods can return information by invocation or subscription. Invocation returns information on a one-time basis. Subscription information is returned either synchronously, on a regular time schedule, or asynchronously, when data becomes available. Method invocation returns a table of results, according to specified arguments (if any).

Methods

AppNode, Application, and Component Methods
Method Name Description Invoke/Subscribe Arguments Output
getBWEngineInfo Retrieves information about TIBCO BusinessWorks Container Edition engine currently installed on the appnode Invoke/subscribe None

Name

Thread Count

Step Count

Debugger Port

Debugger Interface

Persistence Mode

Group Name

Group Provider Technology

State

Errors

getBWApplication Retrieves details of the application deployed on the container Invoke/subscribe None

Name

Version

Application Module

Shared Module

State

State-bit

BWProcessStatisticsCollectionEnabled

getAppNodeRuntimeInfo Retrieves information about runtime state of TIBCO BusinessWorks Container Edition appnode Invoke/subscribe None

AppNode Name

AppNode State

Config State

System Process Id

Up Since

getBWApplicationProcessInfo Retrieves information about system process of TIBCO BusinessWorks Container Edition application. Invoke/subscribe None

System Process ID

Active Thread Count

Total Memory

Used Memory

Free Memory

Used Memory Percentage

Used CPU Percentage

Up Since

Up Since in Milliseconds

Application Name

Application Version

getProcesses Retrieves the details of the process names in the deployed application on the container Invoke/subscribe None

Application Name

Application Version

Process Name

Module Name

getProcessIntanceCount Returns the total number of running process instances for the given application Invoke/subscribe

Process Name (Optional)

Application Name

Application Version

Total Running Processes

getProcessInstanceInfo Retrieves information about the running process instances for a given application Invoke/subscribe

Process ID (Optional)

Process Name (Optional)

Process ID

Process Name

Parent Process Name

Main Process Name

Application Name

Application Version

Status

Start Time

Duration

Duration in numeric type

suspendComponent Suspends the specific component inside a TIBCO BusinessWorks Container Edition application

Invoke

Component Name

None
resumeComponent Resumes the specific component inside a TIBCO BusinessWorks Container Edition application

Invoke

Component Name

None
getComponentStatus Returns details of components inside a TIBCO BusinessWorks Container Edition application. Invoke/subscribe

Component Name

(Optional)

Name

State

State code

Activation status

Starter state

Starter state code

Process Name

Application Name

Application Version

getThreadInfo

Returns the details of a specific thread or all threads running on a particular Java Virtual Machine such as execution information, synchronization statistics of a specific thread or all threads

Invoke/subscribe Thread Name(optional)

Application Name

Application Version

Thread Name

Thread ID

Thread State

User Time

isInNative

Suspended

Blocked Count

Blocked Time

Lock Name

Lock Owner Name

Lock Owner Id

Waited Count

Waited Time

UncaughtException

StackTrace

getVirtualMachineInfo Detects all the Java Virtual Machines started by a user on the local machine and retrieves their detailed information Invoke/subscribe None

Name

Application Name

Applictaion Version

Start Time

Up Time

VM Name

VM Vendor

Version

Current Heap Size

Committed Memory

Maximum Heap Size

Free Heap Size

Heap Usage Percentage

Non-Heap Memory Used

Live Threads

Peak Threads

Daemon Threads

Total Threads Started

Current classes loaded

Total classes loaded

Total classes unloaded

getMemoryPoolInfo Returns the details of memory pools of the Java Virtual Machine process started by a user on a local computer Invoke/subscribe None

Application Name

Application Version

Memory Pool Name

Peak Usage Committed

Peak Usage Init

Peak Usage Max

Peak Usage Used

Memory Pool type

Current Usage Committed

Current Usage Init

Current Usage Max

Current Usage Used

Statistics Collection Methods
Method Name Description Invoke/Subscribe Arguments Output
enableProcessStats

Enables statistics collection for the application processes

Invoke

Process Name (Optional)

None
disableProcessStats

Disables statistics collection for the application processes

Invoke

Process Name (Optional)

None
listProcessesEnabledForStats

Lists all processes currently enabled for statistics collections on the appnode

Invoke/subscribe

None

Process Name

getProcessStats

Retrieves statistics about the processes that are running for the given application because the instrumentation is enabled

Invoke/subscribe

Process Name (Optional)

Process Name

Main Process Name

Application Name

Application Version

Module Name

Module Version

Created

Suspended

Failed

Completed

Total Execution

Average Execution

Total Elapsed

Average Elapsed

Min Elapsed

Max Elapsed

Min Execution

Max Execution

Most Recent Execution Time

Most Recent Elapsed Time

Count Since Reset

getActivityStats

Retrieves statistics about the activities of processes that have been executed for a given application since the instrumentation is enabled

Invoke/subscribe

Process Name (Optional)

Activity Name

Process Name

Application Name

Application Version

Execution Count

Error Count

Last Return Code

Execution Time

Elapsed Time

Min Elapsed Time

Max Elapsed Time

Min Execution Time

Max Execution Time

Most Recent Execution Time

Most Recent Elapsed Time

Execution Count Since Reset

resetProcessStats

Resets the minimum, maximum, and average time statistics for the specified process

Invoke

Process Name (Optional)

None
resetActivityStats

Resets the minimum and maximum time statistics for each activity in the specified process

Invoke

Process Name (Optional)

None
Event Subscription Methods
Method Name Description Invoke/Subscribe Arguments Output
getTracing

Returns list of traces with details

Invoke/subscribe

TraceId

TraceId

ProcessName

ActivityName

TransitionName

ActivityPayload

addTracing

Adds tracing for the specified parameters. Use either asterisk(*) or exact names.

Note: Adding multiple traces impacts the application performance.

Invoke

ProcessName

ActivityName

TransitionName

ActivityPayload

TraceId

onProcessEvent

Gives information about each TIBCO BusinessWorks CE process event from the EventBus. Use addTracing to get relevant TIBCO BusinessWorks CE process events.

Subscribe

None

Type

ApplicationName

ApplicationVersion

ComponentName

ModuleName

ModuleVersion

Timestamp

ComponentProcessName

CustomJobId

JobId

ParentProcessInstanceId

ParentProcessName

ProcessInstanceEndTime

ProcessInstanceFaultMsg

ProcessInstanceFaultStack

ProcessInstanceFaultCauseMsg

ProcessInstanceFaultCauseStack

ProcessInstanceId

ProcessInstanceStartTime

ProcessInstanceState

ProcessName

BWTimestamp

TraceId

onActivityEvent

Gives information about each TIBCO BusinessWorks CE activity event from the EventBus. Use addTracing to get relevant TIBCO BusinessWorks CE activity events.

Subscribe

None

Type

ApplicationName

ApplicationVersion

ComponentName

ModuleName

ModuleVersion

Timestamp

ActivityEndTime

ActivityEvalTime

ActivityExecutionId

ActivityName

ActivityStartTime

ActivityState

IterationCount

ParentActivityExecutionId

ProcessInstanceId

ProcessName

BWTimestamp

SerializedInputDataLength

SerializedInputDataArray

SerializedOutputDataLength

SerializedOutputDataArray

LoopStructure

TraceId

onTransitionEvent

Gives information about each TIBCO BusinessWorks CE activity transition event from the EventBus. Use addTracing to get relevant TIBCO BusinessWorks Container Edition transition events.

Subscribe

None

Type

ApplicationName

ApplicationVersion

ComponentName

ModuleName

ModuleVersion

Timestamp

ProcessInstanceId

ProcessName

TransitionName

TraceId

removeTracing

Deletes traces for the given TraceId

Invoke

TraceId

None