Copyright © Cloud Software Group, Inc. All Rights Reserved

Configuring Hawk Agent

All the required configuration parameters are stored in HAWK_HOME/bin/hawkagent.cfg. Each section in this configuration file begins with “-M” followed by the module name, such as –M Self. Within each modular section, all the command-line options that can be configured are listed. These options are as follows:

Table 6 Hawk Agent Modules and Options

Module	Parameters
-M Self	-cluster <cluster name>
	-agent_name <agent name>
	-agent_domain <agent domain name>
	-hawk_domain <TIBCO Hawk Domain Name>
	-as_session <listen url> <discover url>
	-as_transport_timeout <time in milliseconds>
	-as_receive_buffer_size <buffer size in bytes>
	-as_virtual_node_count <virtual node count>
	-as_worker_thread_count <worker thread count>
	-rvd_session <service> < network> <daemon>
	-ems_transport <ems transport parameters>
	-ssl_ciphers <suite-name(s)>
	-ssl_no_verify_host
	-ssl_trusted <file name>
	-ssl_expected_hostname <host name>
	-ssl_identity <file name>
	-ssl_private_key <file name>
	-ssl_password <string>
	-use_thread_pool <thread pool>
	-character_encoding <character encoding>
	-hma_plugin_dir <directory>
-M RuleBaseEngine	-rulebases <rulebase> <rulebase> …
	-config_path <list of directories to use as configuration sources>
	-auto_config_dir <directory to autoload rulebases at startup>
	-repository_path <list of repositories to use as configuration sources>
	-repository_cache_dir <repository cache dir>
	-variables <property file>
	-email_smtp_server <SMTP hostname>
	-email_smtp_port <server port number>
	-email_smtp_auth_required <true or false>
	-email_smtp_user <username>
	-email_smtp_password <password>
	-email_from <sender email address>
-M AMIService	-ami_rvd_session <service> <network> <domain>
-M LogService	-log_dir <directory to store TIBCO Hawk logs>
	-log_max_size <maximum size of log file>
	-log_max_num <maximum number of log files>
	-log_level <desired trace level for logs>
	-log_format <log format>
-M TIBProtocolAdapter	-interval <heartbeat interval in seconds>
	-security_policy <class that implements security>
-M Repository	-repository_name <repository name>
	-repository_dir <repository directory>
-M LogFileMicroAgent	-scan_rate <scan interval in seconds>
	-block_size <size in kilobytes>
	-eval_rate <rate in seconds>
-M CustomMicroAgent	-timeout <time in seconds>

Each of the parameters listed above are explained in more detail, in the following table.

Table 7 Hawk Agent Configuration Options

Property	Mandatory	Default Value	Description
-cluster	No	IP subnet address	The name of the container in which this agent will appear in the display by default. The display will create the container if it does not already exist. Allows for grouping of multiple agents. The cluster name must be enclosed within quotes, if the name contains spaces.
-agent_name	Yes	Host Name of the computer	Each agent being managed must have a unique combination of agent_name, agent_domain, and hawk_domain values. To use the host name as the agent name, comment this option. Note: Agent names with multiple words separated by dots are not supported.
-agent_domain	Yes	“none”	An agent domain must be specified when two computers within the same TIBCO Hawk domain have the same name but reside in different network domains. For example, you might specify this option as: -agent_domain pa.tibco.com.
-hawk_domain	Yes	“default”	As explained on page 35.
TIBCO DataGrid Transport You can use the same configuration for AMI communication.
-as_session	No	"" tibpgm://8989/	Comment this option if you are using TIBCO EMS or TIBCO Rendezvous as the primary transport. The format is -as_session <listen url> <discover url>. See TIBCO DataGrid Transport for more details. Use a semicolon (;) to indicate a null value, or use an empty string, for example: -as_session "" tibpgm://8989/
-as_transport_timeout	No	30000	Timeout (in milliseconds) used by transport for internal invocations.
-as_receive_buffer_size	No	1000	Internal buffer size in bytes
-as_virtual_node_count	No	100	Virtual node count
-as_worker_thread_count	No	32	Worker threads
TIBCO Rendezvous Transport
-rvd_session	No	7474 "" tcp:7474	TIBCO Rendezvous is the default primary transport for TIBCO Hawk 5.2.0. Comment this option if you are using TIBCO DataGrid or TIBCO EMS as the primary transport. The format is -rvd_session <service> <network> <daemon>. If you use this option, all three parameters must be present and separated by white space. Use a semicolon (;) to indicate a null value, or use an empty string, for example: -rvd_session 7474 "" tcp:7474
TIBCO EMS Transport See page 30 for details
-ems_transport	No		Comment this option if you are using TIBCO DataGrid or TIBCO Rendezvous as the primary transport. Specifies location of the EMS server. For example, -ems_transport tcp://server1:7222. Note: If EMS is configured as Transport, then ami_rvd_session parameter should be configured.
TIBCO EMS SSL Parameters (In case EMS Server is configured for SSL communication). Refer to page 32 for details
-ssl_vendor	No	J2se	The name of the vendor of the SSL implementation. The valid choices are • j2se-default—Use this option when you want to use the default JCE bundled with the Java JRE. On IBM platforms (such as AIX), this option defaults to ibm. • j2se • entrust61—Use this option when you want to use the Entrust libraries. • ibm—On non-IBM platforms, this option can be used only if the IBM version of JCE is installed.
-ssl_ciphers	No	-	Cipher suite name
-ssl_no_verify_host	No	-	Indicate not to verify the EMS server
-ssl_trusted	No	-	File name of the server certificates. The file should be accessible locally/ shared drive
-ssl_no_verify_hostname	No	-	Indicates not to verify the name in CN field of the server certificate
-ssl_expected_hostname	No	-	If the -ssl_no_verify_host is not specified, the option -ssl_trusted has to be used. Along with the option-ssl_trusted specify either -ssl_no_verify_hostname or -ssl_expected_hostname.
-ssl_identity	No	-	Digital certificate
-ssl_private_key	No	-	Private key
-use_thread_pool	No	256	Optimizes the number of threads the agent creates for every microagent it discovers. It is advisable to turn this option On if the agent is going to discover over 100 microagents. This value is OS dependent and should be set to the maximum number of threads allowable per process.
-character_encoding	No	UTF-8	Character encoding to be used across the configured transport
-hma_plugin_dir	No	CONFIG_FOLDER/plugin	Specify the plug-in directory path.
-rulebases	No	-	List of .hrb files to be loaded at the startup
-config_path	No	CONFIG_FOLDER/config	The list of directories to use as configuration sources. Used in the case of manual configuration. The delimiter for path entries is a colon (:). If -config_path is used, comment the -auto_config_dir, -repository_path, and -repository_cache_dir options.
-auto_config_dir	No	CONFIG_FOLDER/autoconfig	The directory to auto-load Rulebases at the startup. If this option is present, the agent runs in an automatic configuration mode. Specify the directory from which the Rulebase and schedule configuration objects are loaded at the startup. The default directory, HAWK_HOME/autoconfig, is used if a value is commented. If you use automatic configuration, comment the following options: -config_path, -repository_path, -repository_cache_dir, -rulebases
-repository_path	No	-	List of repositories to use as configuration sources. If repository configuration mode is used, specify the path to be searched for repositories. The delimiter for path entries is a colon (:). The default used if this option is commented is the current working directory. If -repository_path is used, comment the -auto_config_dir and -config_path options.
-repository_cache_dir	No	CONFIG_FOLDER/cache	If repository configuration mode is used, all configuration objects loaded from the repository may be cached in a local directory, specified in this option. This cache is used if a repository fails, and also to minimize network traffic. If -repository_cache_dir is used, comment the -auto_config_dir and -config_path options.
-variables	No	-	Properties file to specify variables file. The variables file can pass data to define external variables to be passed to rules for use in Rulebase configurations.
Email Configurations Email configuration options are used to send the notification email.
-email_smtp_server	No	-	Specifies the hostname of the SMTP server.
-email_smtp_port	No	25	Specifies the port at which the SMTP server is listening.
-email_smtp_auth_required	No	false	Specifies whether authentication is required for the SMTP server. The default value is false. If the value is true, you need to provide the username (-email_smtp_user) and password (-email_smtp_password) for authentication.
-email_smtp_user	No	-	Specifies the sender’s username for the SMTP server authentication. The field is mandatory if the authentication option (-email_smtp_auth_required) is set to true.
-email_smtp_password	No	-	Specifies the sender’s password for the SMTP server authentication. The field is mandatory if the authentication option (-email_smtp_auth_required) is set to true.
-email_from	No	-	Specifies the sender’s email address for sending the email. The default is the current system user, for example, "HawkAdministrator"<admin@abc.com>
Configuration for AMI communication AMI communication configuration option is used only in the case of TIBCO Enterprise Message Service or TIBCO Rendezvous transport. For TIBCO DataGrid, it is ignored.
-ami_rvd_session	No	7474 127.0.0.1 tcp:7474	Configures the agent with a RVD session to be used to communicate with applications implementing the TIBCO Hawk Application Management Interface. Multiple -ami_rvd_session parameters may be specified. If none are specified, the RV session used for AMI is the primary session of the Self Module. # Note: When using TIBCO EMS transport for communication, 127.0.0.1 should be used as the network parameter. For example: ami_rvd_session 7474 127.0.0.1 tcp:7474
Logging
-log_dir	No	CONFIG_FOLDER/log	The directory in which to store log files generated by the TIBCO Hawk Agent.
-log_max_size	No	10240	The maximum size of a rotating log files in Kbytes.
-log_max_num	No	10	The maximum number of rotating log files
-log_level	No	7	Specifies the level of diagnostic information stored in the logs. The following are the logging levels: 4 - Indicates error level trace messages should be enabled. 6- Indicates warning level trace messages should be enabled. 7 - Indicates information level trace messages should be enabled. 8 - Indicates debug level trace messages should be enabled. 16 - Indicates AMI level trace messages should be enabled. A value of zero turns all tracing off. A value of -1 turns all tracing on.
-log_format	No	“default”	The format for trace log messages
TIBCO Protocol Adapter
-interval	No	30 seconds	The heartbeat interval in seconds. Not available for TIBCO DataGrid transport.
-security_policy	No	-	The fully qualified name of the Java class which implements the security policy. For more information refer to Chapter 4, TIBCO Hawk Security Model.
Rulebase Repository
-repository_name	No	-	The name of the Rulebase Repository
-repository_dir	No	-	The location of the Repository
Logfile MicroAgent
-scan_rate	No	10 seconds	The rate at which log files are scanned.
-block_size	No	16 KB	The maximum number of kilobytes to read on each scan.
-eval_rate	No	300 seconds	The rate at which all the log files being monitored are re-evaluated.
Custom MicroAgent
-timeout	No	30 seconds	The timeout value for commands executed by the custom MicroAgent.

Logging for TIBCO Hawk Agent

TIBCO Hawk 5.2.0 provides two different modes of logging: trace mode and log4j mode.

Trace Logging Mode

By default, Hawk Agent uses the trace mode for logging requirements. TIBCO Hawk 5.2.0, uses the trace mode logging mechanism to match parity with different versions of Hawk, bundled in different TIBCO products.

The logging parameters for Hawk Agent, Hawk MicroAgent, and Hawk Event are configured using the logging parameters defined their respective configuration files. For more details on these logging parameters, refer the following sections:

•	Table 7, Hawk Agent Configuration Options

•	Table 8, HMA Configuration Properties

•	Table 10, Hawk Event Service Configuration Properties

Log4j Logging Mode

In TIBCO Hawk 5.2.0, you can enable the log4j mode for Hawk Agent logging requirements. By default, the log4j mode is disabled for Hawk Agent. Modify the log4j configuration in the respective .tra files to enable the log4j for logging.

The configuration for Hawk Agent is included in tibhawkagent.tra at:

java.extended.properties=-Duse_log4j=false -Dlog4j.configuration=%HAWK_CONFIG_HOME%/bin/log4j_agent.properties

To enable the log4j for logging, update the value of the -Duse_log4j parameter to true in the configuration mentioned above.

Specify “-Dlog4j.configuration” as command-line parameter to override the log file configuration.

A default log4j properties file exists at CONFIG_FOLDER/bin/log4j_agent.properties. You can modify this configuration file or use your own properties file.

The logging properties specified in hawkagent.cfg for –M LogService viz. log_dir, log_max_size, log_max_num and log_level override those in log4j RootLogger’s RollingFileAppender.

Use of -log_level Parameter in Agent Configuration

If –log_level <int_value> is specified in –M LogService section of agent configuration and the value of log_level is greater than seven, the log4j root logger level is set to DEBUG.

Note:

•	Ensure that the log4j configuration file specified above must have at least one RollingFileAppender applied to the Root logger.

•	Agent logging configuration properties given in hawkagent.cfg only apply to RollingFileAppender for the Root category (Logger). If there are sub-categories with different file appenders, the agent properties will not override them.

•	Log4j.xml configuration file is not supported.

Mapping of TIBCO Hawk default Util Logging Levels with Log4j:

Util Logging (in Hawk Agent)

Util Logging Level	Log4j Logging Level
Log.INFO (value 0)	INFO
Log.WARNING (value 1)	WARN
Log.DEBUG (value 2)	DEBUG
Log.ERROR (value 3)	ERROR
Log.EVENT (value 4)	INFO
Log.EXCEPTION	EXCEPTION

Trace Logging (in AMI)

Util Logging Level	Log4j Logging Level
Log.ALWAYS (value 0)	DEBUG
Log.INFO (value 1)	INFO
Log.WARNING (value 2)	WARN
Log.ERROR (value 4)	ERROR
Log.DEBUG (value 8)	DEBUG
Log.AMI (value 16)	INFO

Copyright © Cloud Software Group, Inc. All Rights Reserved