Hawk Event Service Configurations

The Hawk Event Service records:

• All alerts raised and cleared by TIBCO Hawk Agents across the network, as well as the changes in Agent’s alert level
• Record events reported by agents in text files or relational databases using JDBC
• Asynchronously notify using AMI

Refer to the TIBCO Hawk Concepts Guide for details about TIBCO Hawk Event Service.

All the required configuration parameters are stored in CONFIG_FOLDER/bin/hawkevent.cfg. The following table describes various Hawk Event Service related configuration properties in easy-to-understand logical groups. The various groups are as follows:

Hawk Event Service Configuration Properties

Logical Group

Parameters

TIBCO Rendezvous (RVD) Session

-rvd_session <service> <network> <daemon>

TCP Transport for TIBCO Hawk

-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>
  -max_reconnect_attempts_during_connect
  -max_reconnect_attempts_after_restart
  -max_reconnect_attempts_during_connect_for_ami
  -max_reconnect_attempts_after_restart_for_ami

TIBCO Hawk Domain

-hawk_domain <TIBCO Hawk domain name>

Logging Information

-logdir <directory to store Event Service logs>

 

-logmaxsize <maximum size of one Event Service log>

 

-logmaxnum <maximum number of Event Service logs>

 

-log_level <desired trace level for logs>

 

-log_format <Hawk or ActiveEnterprise format>

Fault Tolerance

To enable fault tolerance, uncomment the -ft parameter.

This instance joins a fault tolerant group named HawkEventService:hawkdomain, where hawkdomain is the domain of the agent.

Note 

Separate instances of TIBCO Hawk must be running on at least two machines in order to use fault tolerance. Fault tolerance must be enabled on each instance

Weight

Assign the weight of this instance using a positive integer. The member with the highest weight receives rank 1 (so it outranks all other members). When an instance fails, the next-highest instance is activated and the member with the next highest weight receives rank 2; and so on.

Hawk Event Service Configuration Properties

Logical Group

Parameters

Fault tolerance

-ft <fault tolerance weight>

 

-ft_rvd_session <service> <network> <daemon>

File based event store

-datadir

 

-datamaxsize

 

-datamaxnum

Database based event store

-JDBCdriverClassName

 

-JDBCuserName

 

-JDBCpassword

 

-JDBCurl

 

-JDBCdbType

 

-JDBCalertTableFields

Be careful not to confuse TIBCO Hawk Event Service data files (Event.dat) with Event Service log files (Event.log).

• Event.dat data files contain the data produced by the Event Service.
• Event.log log files record the state of the Event Service itself.

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

Hawk Event Service Configuration Parameter Details

Property

Mandatory

Default Value

Description

-hawk_domain

Yes

“default”

See Hawk Domain for details.

-agent_name

Yes

Host Name of the computer

The name of the agent. Each Microagent being monitored must have agent_name, by which Microagent is being monitored

TIBCO Rendezvous Transport

-rvd_session

No

7474 "" tcp:7474

Comment this option if you are using TCP Transport for TIBCO Hawk 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

TCP Transport for TIBCO Hawk 

-tcp_session

No

localhost:2582 localhost:2561

Set this option to configure the TCP Transport for TIBCO Hawk as the primary transport for the communication.

The syntax of the property is:

-tcp_session <self_IP>:<port> <cluster_manager_IP>:<port>

where,

• <self_IP>:<port> - The unique socket address of the Hawk Event service for joining the cluster.
• <cluster_manager_IP>:<port> - The socket address of the Hawk 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 hawktcpdaemon.cfg.

TCP Transport for TIBCO Hawk SSL Parameters

The following TLS/SSL parameters are applicable to -tcp_session and -ami_tcp_session.

-tcp_key_store

No

-

Path of the key store file

-tcp_trust_store

No

-

Path of the trust store file

-tcp_key_store_password

No

-

Password for the key store file

-tcp_key_password

No

-

Encrypted key password

-tcp_trust_store_password

No

-

Password for the trust store file

-tcp_ssl_protocol

No

TLSv1.2

Protocol for a secure connection

-tcp_enabled_algorithms

No

TLS_RSA_WITH_AES_128_CBC_SHA

Algorithm to be used for the security protocol. You can specify multiple algorithms as comma-separated list without space.
-max_reconnect_attempts_during_connect No 20 Specifies the number of reconnection attempts when the console is unable to connect on first attempt
-max_reconnect_attempts_after_restart No 1000 Specifies the number of reconnect attempts to be made when the agent gets disconnected from the Daemon
-max_reconnect_attempts_during_connect_for_ami No 20 Specifies the number of reconnection attempts when AMI is unable to connect on first attempt.
-max_reconnect_attempts_after_restart_for_ami No 1000 Specifies the number of reconnect attempts when the connection disconnects from the agent after a connection has been established.

TIBCO EMS Transport

-ems_transport

No

 

Comment this option if you are using TCP Transport for TIBCO Hawk or TIBCO Rendezvous as the primary transport.

Specifies location of EMS server. For example,

-ems_transport tcp://server1:7222.

Note: If EMS is configured as Transport, the ami_rvd_session parameter should be configured.

TIBCO EMS SSL Parameters (In case EMS Server is configured for SSL communication).

-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.
• 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

-character_encoding

No

UTF-8

Character encoding to be used across the configured transport

Logging

-logdir

No

CONFIG_FOLDER/logs

The directory in which to store log files generated by the TIBCO Hawk Event Service

-logmaxsize

No

10M

The maximum size of a rotating log files in Kbytes

-logmaxnum

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
 

No

-

Specifies the fully-qualified name of an executable file to be executed when an agent is lost.

-security_policy

No

-

Fully qualified name of the Java class which implements security policy. For more information refer to TIBCO Hawk Security Model.

-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.

Configuration for AMI communication

-ami_rvd_session

No

 

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

-ami_tcp_session

No

localhost:2575 localhost:2571

Configures the agent with a TCP session to be used to communicate with applications implementing the TIBCO Hawk Application Management Interface.

The syntax for the property is:

-ami_tcp_session <self_IP>:<port> <hawk_agent_IP>:<AMI_session_port>

where,

• <self_IP>:<port> - The unique socket address of the Hawk Event service for AMI communication. The socket address should be different from the <self_IP>:<port> specified for the -tcp_session property of Hawk Event Service.
• <hawk_agent_IP>:<AMI_session_port> - The socket address of the Hawk agent for AMI communication. This socket address is same as <self_IP>:<port> specified for the -ami_tcp_session parameter in hawkagent.cfg.

Fault Tolerance

-ft

No

-1

Fault tolerance weight

-ft_rvd_session

  

7474 127.0.0.1 tcp:7474

TIBCO Rendezvous session used for fault tolerance.

This option is ignored if the -ft option is not specified.

File Based Event Store

-datadir

No

null

Specifies the location to store data files generated by the TIBCO Hawk Event Service. If not specified, events are not logged.

-datamaxsize

  

1M

The maximum size of a rotating data file in KB. You may apply a suffix m or M for indicating MB values (for example, 10m).

-datamaxnum

No

4

The maximum number of rotating data files

Database Based Event Store

-JDBCdriverClassName

No

-

Class name for the vendor's JDBC driver. For example,

com.microsoft.jdbc.sqlserver.SQLServerDriver

-JDBCuserName

No

-

User name to connect to the database

-JDBCpassword

No

-

User’s password to connect to the database

-JDBCurl

No

-

URL which identifies the database connection

-JDBCdbType

No

-

Database vendor, valid/supported values are ORACLE, SQLSERVER, DB2 or SYBASE

-JDBCalertTableFields

No

-

User defined alert action property fields to be created as additional columns in the HawkAlertClearInfo table

Database Configuration

To setup database, add the appropriate .jar file of the JDBC driver classes, from the database vendor, to the HAWK_HOME/lib based on the value of the -JDBCdbType parameter.

 

-JDBCdbType Value

Required .jar Files

ORACLE

ojdbc6.jar

SQLSERVER

sqljdbc.jar

sqljdbc4.jar

DB2

jconn3.jar

SYBASE

db2jcc4.jar