Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 4 AMI API : AMI Basics

AMI Basics
This section presents a brief overview of the TIBCO Hawk Application Management Interface (AMI).
AMI API is an API used to instrument an application in order to make it manageable by the Hawk System. It is shipped in Java/C/C++ language bindings.
The instrumented application usually connects to the Hawk Agent on the same machine. However, this is not a requirement. You can connect it to a Hawk agent on another machine.
However, it is required that one instrumented application instance only connects to one Hawk Agent.
An Instrumented Application Looks like a Microagent
You interact with the instrumented application using the TIBCO Hawk agent by calling the methods of microagents associated with that agent. An AMI-instrumented application appears and acts as though it were a microagent in the TIBCO Hawk system.
Interaction with an AMI-instrumented application can use the following means:
An example of this might be using the TIBCO Hawk WebConsole to survey many instances of the instrumented application by means of a network query. Another example might be to make simultaneous changes to many such instances by performing a network action.
An example of this might be creating rulebases to monitor the application’s error state, detect critical conditions, and increase the output of debug information until the problem is resolved.
 
Note: An instrumented application is not dependent on the presence of an TIBCO Hawk agent. The relationship between TIBCO Hawk agent and TIBCO Hawk instrumented application is completely voluntary. The management interface might be active only in some instances of the application, or only at specific times during an instance’s activity.
A management interface can be divided into two major portions:
Monitoring an Instrumented Application through the TIBCO Hawk WebConsole
The TIBCO Hawk WebConsole is a console application that displays the status of all agents. It is used to view alerts, interact with agents and their microagents, and edit rulebases and other configuration objects. A microagent is an object used by a TIBCO Hawk agent to carry out certain related tasks: to run scripts, to obtain file system information such as free hard disk space or to retrieve a process table. In the TIBCO Hawk WebCosole, instrumented applications appear in the list of microagents, using the name that the application provides through its AMI interface. See Chapter 2, Console API for more information on rulebases and microagents. Any methods thus made visible appear as if they are microagent methods, with arguments and results as described.
Interaction with an instrumented application can occur in the following ways:
Connecting AMI Participants
An instrumented application can communicate with AMI manager through TIBCO Rendezvous transport. Such instrumented application should use a similar AMI transport configuration to the one being used by its manager.
If you are using a TIBCO Hawk agent as your manager, start the TIBCO Hawk agent with the same service, network, and daemon options for its primary monitoring session as for the TIBCO Rendezvous session set up in the application.
You can also configure the agent to use additional TIBCO Rendezvous sessions to monitor AMI activity. See the TIBCO Hawk Installation, Configuration, and Administration Guide for details on configuring agents to use additional AMI sessions.
 

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved