Configuration of Hawk® Microagent for TIBCO FTL/TIBCO eFTL
You must perform the following configuration tasks after installation of Hawk® Microagent for TIBCO FTL/TIBCO eFTL.
Configuring TIBCO Hawk to Use the Microagent
Perform the following steps to configure the microagent in your TIBCO Hawk installation:
- Procedure
- In the
hawkagent.cfg file, uncomment the
-hma_plugin_dir
property and ensure that the property has the value CONFIG_FOLDER/plugin. This option specifies the directory that is searched when loading the microagent plug-ins. For more information, see the TIBCO Hawk Installation and Configuration guide. - Copy the hawkftl.hma and ftlserverconfig.yaml files from TIBCO_HOME/hawk/<version>/plugin/ftl to CONFIG_FOLDER/plugin directory.
- Edit the
ftlserverconfig.yaml file and specify the url, username and password of the FTL server. If the servers are in fault tolerance mode, you can specify multiple server details. Specify server details of the secondary servers by uncommenting the
url
,username
andpassword
fields. - In the hawkftl.hma file verify that the file has correct trace log configurations. If you are configuring an SSL connection to the TIBCO FTL server, set the additional SSL arguments in the hawkftl.hma file. For more information on configuration parameters, see Configuration Parameters.
- Restart the TIBCO Hawk Agent.
Configuration Parameters
The following table lists configuration fields in the hawkftl.hma file:
Parameter | Description |
---|---|
-methodTimeout
|
Time (in seconds) for which the microagent waits for the FTL server to respond to queries. |
serverInMicroagentName
|
Includes the server url with the microagent name. To monitor multiple FTL servers on one Hawk agent, you must set the value of this parameter as true. Default value: False |
--ftlServerConfigFile
|
Location of the YAML file that contains TIBCO FTL server details.
Default value: <CONFIG_FOLDER>/plugin/ftlserverconfig.yaml |
-traceDir
|
Path of the plugin trace directory. Default value: <CONFIG_FOLDER>/logs |
-traceFilename
|
Name of the trace file.
Default value: hawkftl.log |
-traceLevel
|
Specifies the level of diagnostic trace output. The desired trace level is specified by adding the following values together: Default value: Allowed values are: 2 - Indicates warning level trace messages should be enabled. 4 - Indicates error level trace messages should be enabled. 7 - Indicates info level trace messages should be enabled. 8 - Indicates debug level trace messages should be enabled. |
-sslEnabled |
To enable secure communication, set this parameter to
true .
Default value: |
-truststorePath
|
Trust store file (.p12,
jks, pem ) path.
|
-trustStorePassword
|
Trust store password. Password can be in encrypted format.
You can use the
|
-trustStoreType
|
Type of the truststore file. The supported truststore types are PEM, PKCS12, and JKS. |
-skipCertificateValidation
|
Flag to indicate whether certificate validation must skipped. Default value: |
The following table lists the configuration parameters in the ftlserverconfig.yaml file. If the FTL servers are in fault tolerance mode, you can specify more than one server details in this file.
Parameter | Description |
---|---|
url
|
TIBCO FTL server URL |
username
|
Username for the FTL server |
password
|
Password for the FTL server.
You can use the
|