COM.TIBCO.hawk.microagent.Self

Microagent

Purpose

The Self microagent (on all platforms) returns information from and takes actions that affect the TIBCO Hawk agent itself. You use its methods to examine release version and auto-configuration information, to examine active microagents, and to start and stop diagnostic tools you might need when speaking to technical support personnel.

Remarks

Because the Self:turnDiagnosticsOn and Self:turnDiagnosticsOff methods can affect the agent’s performance, you should only use these methods when asked to do so by TIBCO Hawk technical support.

Methods

 

Method

Description

Page

Self:getMicroAgentInfo

Returns information about the microagents currently active

Self:getMicroAgentInfo

Self:getAgentTimeZone

Returns information about the agent time zone

Self:getAgentTimeZone

Self:getSecurityInfo

Returns information about the current security policy

Self:getSecurityInfo

Self:getComponentInfo

Returns version information about components in the current release

Self:getComponentInfo

Self:turnDiagnosticsOn

Turns on agent diagnostics

Self:turnDiagnosticsOn

Self:turnDiagnosticsOff

Turns off agent diagnostics

Self:turnDiagnosticsOff

Self:getUptime

Returns how long the agent has been running

Self:getUptime

Self:doAMIDiscovery

Re-discovers all AMI instrumented applications

Self:doAMIDiscovery

Self:onMicroAgentEvent

Reports the change in the status of the microagent

Self:onMicroAgentEvent

Proprietary Methods

The following method of the Self microagent is proprietary. The TIBCO Hawk system does not support direct user invocation of this method from the TIBCO Hawk Display or Console API.

However, this method is used indirectly by the TIBCO Hawk Display when interacting with agents and thus has security implications.

Method Name

Impact

Description

describe

Info

This method retrieves microagent descriptors