Configuring the Microagent in TIBCO Hawk® - Container Edition

If you are running TIBCO FTL in docker environment, you can monitor your FTL applications using Hawk® Container Edition. Hawk® Container Edition is a tool for monitoring distributed applications in the container environment. To add Hawk® Microagent for TIBCO FTL/TIBCO eFTL plug-in to the Hawk agent container perform the following steps:

Prerequisites

  • Download and install Hawk® Microagent for TIBCO FTL/TIBCO eFTL in the same TIBCO_HOME where you have installed TIBCO Hawk.
  • Download Hawk Container Edition software package from the TIBCO Software Product Download Site. Extract the Hawk Container Edition archive file to a temporary directory on the machine. For Hawk Container edition concepts and procedures, see TIBCO Hawk Container Edition documentation.

Procedure

  1. Copy hawkftl.jar and all the dependent jars from <TIBCO_HOME>/<version>/plugin/ftl/lib folder to <TEMP_DIRECTORY>/tibco.home/hkce/<version>/plugin folder.
  2. Copy hawkftl.hma and ftlserverconfig.yaml files from <TIBCO_HOME>/<version>/plugin/ftl/ folder to <TEMP_DIRECTORY>/tibco.home/hkce/<version>/plugin folder.
  3. Create logs folder in the <TEMP_DIRECTORY>/tibco.home/hkce/<version>/plugin directory.
  4. In the hawkftl.hma file, update relative path of the jars. For example: 
    <classpath>
<path>/tibco.home/hkce/2.0/plugin/hawkftl.jar</path>
<path>/tibco.home/hkce/2.0/plugin/commons-logging-1.2.jar</path>
<path>/tibco.home/hkce/2.0/plugin/httpclient-4.5.10.jar</path>
<path>/tibco.home/hkce/2.0/plugin/httpcore-4.4.12.jar</path>
<path>/tibco.home/hkce/2.0/plugin/jackson-annotations-2.9.0.jar</path>
<path>/tibco.home/hkce/2.0/plugin/jackson-core-2.9.9.jar</path>
<path>/tibco.home/hkce/2.0/plugin/jackson-databind-2.9.9.jar</path>
<path>/tibco.home/hkce/2.0/plugin/jackson-module-jaxb-annotations-2.9.9.jar</path>
<path>/tibco.home/hkce/2.0/plugin/snakeyaml-1.23.jar</path>
<path>/tibco.home/hkce/2.0/plugin/jackson-dataformat-yaml-2.9.9.jar</path>
</classpath>
  5. In the hawkftl.hma file, update FTL server details yaml file location and log file location. For example: 
    <arg>--ftlServerConfigFile</arg>
<arg>/tibco.home/hkce/2.0/plugin/ftlserverconfig.yaml</arg>
<!--Trace Configuration -->
<arg>-traceDir</arg>
<arg>/tibco.home/hkce/2.0/plugin/logs</arg>
  6. In the<TEMP_DIRECTORY>/tibco.home/hkce/<version>/plugin/ftlserverconfig.yaml file, update TIBCO FTL server details.
  7. Rebuild the Hawk agent Docker image by running the script <TEMP_DIRECTORY>/tibco.home/hkce/<version>/docker/build_hkce_agent.sh.
  8. Run the containers. While running the containers, ensure that the hma_plugin_dir environment variable of hkce_agent is set to value /tibco.home/hkce/<version>/plugin/.
  9. If Hawk Console is running, you can confirm if the plug-in is loaded in Hawk agent by checking the list of microagents in the Hawk console. Check if the methods of the plug-in microagent are listed and if you can invoke and subscribe them.