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


Chapter 2 TIBCO Hawk Component Configurations : Hawk Agent Configurations

Hawk Agent Configurations
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:
-cluster <cluster name>
-agent_name <agent name>
-agent_domain <agent domain name>
-hawk_domain <TIBCO Hawk Domain Name>
-rvd_session <service> < network> <daemon>
-tcp_session <self_IP>:<port> <cluster_manager_IP>:<port>
-tcp_key_store <key store file path>
-tcp_trust_store <trust store file path>
-tcp_key_store_password <key store password>
-tcp_key_password <key password>
-tcp_trust_store_password <trust store password>
-tcp_ssl_protocol <security protocol>
-tcp_enabled_algorithms <security algorithms>
-ems_transport <ems transport parameters>
-ssl_ciphers <suite-name>
-ssl_trusted <file name>
-ssl_identity <file name>
-use_thread_pool <thread pool>
-character_encoding <character encoding>
-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_from <sender email address>
-email_content_type <content type>
-ami_rvd_session <service> <network> <domain>
-ami_tcp_session <self_IP>:<port>
-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>
-interval <heartbeat interval in seconds>
-security_policy <class that implements security>
-repository_name <repository name>
-repository_dir <repository directory>
-scan_rate <scan interval in seconds>
-block_size <size in kilobytes>
-eval_rate <rate in seconds>
Each of the parameters listed above are explained in more detail, in the following table.
-tcp_session <self_IP>:<port> <cluster_manager_IP>:<port>
<self_IP>:<port> - Unique socket address of the Hawk agent for connecting to the cluster.
<cluster_manager_IP>:<port> - The socket address of the Cluster Manager acting as the seed node for the cluster. This socket address is same as <cluster_manager_IP>:<port> specified for the -tcp_session parameter in the Hawk Cluster Manager (hawktcpdaemon.cfg).
-tcp_session <self_IP>:<port> <daemon1_IP>:<port>, <daemon2_IP>:<port>
The following TLS/SSL parameters are applicable to -tcp_session and -ami_tcp_session.
CONFIG_FOLDER/autoconfig
Specifies whether authentication is required for the SMTP server. The default value is false. If the value is true, you need to provide the user name (-email_smtp_user) and password (-email_smtp_password) for authentication.
Specifies whether TLS encryption is required for the SMTP server. If set to true, use of the STARTTLS command is required (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands.
-ami_tcp_session <self_IP>:<port>
where, <self_IP>:<port> is the unique socket address for communication with TIBCO Hawk Application Management Interface.
Logging for TIBCO Hawk Agent
TIBCO Hawk 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, 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:
Log4j Logging Mode
In TIBCO Hawk, 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:
Mapping of TIBCO Hawk default Util Logging Levels with Log4j:

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