Copyright © Cloud Software Group, Inc. All Rights Reserved
Copyright © Cloud Software Group, Inc. All Rights Reserved


Chapter 3 Getting Started with Hawk Admin Agent : Accessing Hawk from TEA Web User Interface

Accessing Hawk from TEA Web User Interface
You can use the TEA Web UI to connect to the TEA server.
Prerequisites
You must start the TEA server before logging in to the TEA Web UI. Navigate to the <TIBCO_HOME>\tea\<version>\bin directory and double-click tea.exe.
Procedure
1.
http://<IP address>:<port_number>/tea
where <IP address> is the address of the machine where the Admin Agent is installed and the default <port_number> is 8777.
For example, http://localhost:8777/tea
The default port number and other settings can be changed by modifying the settings in tea.conf file that is located in the <TIBCO_CONFIG_HOME>\tibco\cfgmgmt\tea\conf folder.
2.
Username: admin
Password: admin
Refer to the TEA documentation for password policies if you would like to change the password.
On successful authentication, the landing page is displayed. The username with which you logged in is shown as a menu option in the title pane.
The default timeout for a session is 30 minutes.
If the Admin Agent is registered with TEA, you should see the TIBCO Hawk product card after you log in to TEA.
Figure 1 TIBCO Enterprise Administrator
The Left Navigation Bar
The left navigation bar contains some icons that are links to the various views in TEA. Refer to the TIBCO Enterprise Administrator User’s Guide for more information on them.
Viewing Hawk Domain
Click the TIBCO Hawk product card to view all the Hawk domains.
Figure 2 Hawk Domains
The following information is displayed in each domain card:
Rulebases: number of rulebases defined on the all agents in the domain
Agents Alive: number of agents that are up and in a running state out of the total number of agents that belong to the domain.
High Alerts: number of alerts with a ’high’ status that are generated for all agents in the domain.
Total Alerts: total number of alerts generated for all agents in the domain.
For more details on any particular domain, click the domain card for that domain. See Viewing Agents in a Domain for details.
Viewing Agents in a Domain
Click a Domain card to display the Hawk Agents page, which displays all the Hawk agents that belong to that domain.
Figure 3 Hawk Agents View
Each agent card in the Hawk Agents view displays the following details:
Up Since: the timestamp when the agent was started.
IP Address: IP address of the agent machine.
Status of the agent as Up, or Down button. You can click the Up button to open a dashboard view of the agent.
Rulebases: displays the number of rulebases defined on the agent.
Micro Agents: displays the number of Microagents for the agent.
High Alerts: displays the number of alerts with the status ’high’ generated for the agent.
Total Alerts: the total number of alerts generated for the agent.
To get more detailed description of the agent, click anywhere on the agent card. See Viewing the Agent Details for details.
Viewing the Agent Details
To get a detailed description of an agent, click anywhere on the agent card in the Hawk Agents page. The Agent Description page is displayed. You can also get to this page by clicking the Dashboard icon on the left panel.
Figure 4 Agent Description
The Agent Description page displays the alert list as well as a pie chart representation of alerts. It displays the following details about the agent:
Last Update: timestamp when the agent was last updated.
DNS: DNS of the agent.
IP: IP address of the machine on which it is running.
Cluster: IP address of the cluster that the agent machine belongs to
Platform: Operating system installed on the machine on which the agent is running.
Up Since: Timestamp when the agent was started
Latest 10 Alerts: details of the last 10 alerts that were generated for the selected agent.
Alert by Severity: Displays a pie chart showing the number of High, Medium, Low and Notification status alerts.
The Agent Description page contains a left navigation panel. Click an icon in the left panel to get the specific details of the agent.
Figure 5 Hawk Agent Description: Left Panel
Dashboard
The Dashboard icon takes you to the Agent Description page where you can see the details of the agent from which you clicked the Dashboard icon.
Alerts
When you click the Alerts icon, you get the latest alerts in a tabular format for the selected agent.
Figure 6 Alerts
You can display 10, 25, 50 or 100 alerts on a page by selecting the number from the records per page drop-down menu. For each alert, the following details are provided:
Description: a string that describes the alert.
Severity: type of severity which can be one of High, Medium, Low, or Notification.
Time: timestamp when the alert was generated.
Rulebase: name of the rulebase which generated this alert.
Rule: name of the rule that triggered the alert.
Actions: the action that you want to take on this alert. You can either Suspend (make it inactive) the alert for an specified amount of time or Delete it by clicking on the appropriate button in this column.
Searching Across Alerts
You can search individual columns by using the Search box above that column or to search across all columns use the stand-alone Search box located on the top right of the page.
Alert, Rule, and Rulebase Details
To get the details of an alert or the details of the rulebase that triggered the alert, click its Description link or the Rulebase link. Alert details such as the Alert text and the Alert ID are displayed. Rulebase details such as the Rulebase name, its data source, the rule that triggered this alert, the rule description, action, and DataIndex are displayed.
Microagents
Each agent has a set of default microagents, that are discovered by agents when it is started. If you install and start an adapter or gateway, or instrument an application with AMI, microagents for these objects are dynamically added to the agent. When you click the Microagents icon, you can view microagents and their methods for any discovered TIBCO Hawk agents. For more details on microagents, see TIBCO Hawk Concepts Guide.
Figure 7 Microagents
 
You can click any microagent to get the following details:
Description: Displays the name and possibly some text describing the selected microagent. All the methods available for the selected microagent are displayed in a table in the panel beneath the description.
The following details for each method are displayed in a table:
Method Name: Displays the name of the method.
Method Description: Describes what the method does.
Type: Subscription information is returned either synchronously, on a regular time schedule, or asynchronously, when data becomes available.
Return Type: Data is returned as Tabular Data, or Composite data.
Invoke: Use the Invoke mode to immediately view the results. Invoking is useful when you want to test a method before using it in a rule, or to check a return value for troubleshooting purposes. This example demonstrates the Invoke mode of operation.
Subscribe: Use the Subscribe mode to view the microagent method results over time. Creating a subscription is useful when you want to test a range of return values before specifying boundaries in a rule, or to identify general patterns of activity.
Exporting the Description for a Microagent
You can either view or download the microagent description to a file. Click the Export MAD link in the Description panel and select whether you want to open it or save the file locally.
Rulebases
A rulebase is a collection of one or more rules. A rule is a user-defined monitoring policy. It specifies the following:
Figure 8 Rulebases
The Rulebases page shows all the rulebases for the agent. You can select the number of rulebases displayed on a page by selecting 10, 25, 50 or 100 from the records per page drop-down menu.
The following information is displayed for each rulebase:
Name: the name of the Rulebase
Status: whether the rulebase is deployed or undeployed
Rule Count: the number of rules in the Rulebase
Alert Count: the number of alerts generated by the Rulebase on the agent
Author: name of person or entity that created the Rulebase
Description: text used to describe the Rulebase
Schedule: the name of the schedule that is used by the Rulebase
Actions: you can take the following actions on the Rulebase:
Getting the Details of a Rulebase
Click on a Rulebase name to see the details of the Rulebase. The page for a specific Rulebase displays the details of the Rules in that Rulebase in addition to its author, description, schedule used, and alert count.
The following information about the Rules is displayed:
Name: name of the rule
Microagent Name: name of the microagent that uses this rule
Method Name: name of the method to be invoked to retrieve data
Interval: interval in seconds between two subsequent method invocation
Schedule: schedule used by this rule
Actions: actions that can be taken on the rule are:
Click a Rule name to see the details for the Rule.
You can also do the following from an individual Rulebase page by clicking on these links:
Edit Rulebase: edit or update name, description or schedules used in the Rulebase
New Rule: create a new rule in the Rulebase
Undeploy Rulebase: undeploy the Rulebase from the current agent
Get Alerts: get a list of the alerts that are generated by this Rulebase
Export Rulebase: export this Rulebase to a .hrb file on your local machine
Deploy To: deploy this Rulebase to other agents
Undeploy From: undeploy the rulebase from an agent on which it was previously deployed
Schedules
The Admin agent allows you to create one or more schedules for when the rules should trigger.
Figure 9 Schedules
Adding and Deploying a New Schedule
You can create a new schedule and deploy it to a rulebase, a rule, or a condition within a rule. To add a new schedule follow these steps:
1.
Click the Schedules icon in the left vertical pane. The Schedules page will open.
2.
Click the +New Schedule link to open the Schedule dialog.
3.
4.
5.
Click the +Save button. You should see your newly created schedule added on the Schedules page.
6.
Click the name of your new schedule. You can specify the time, day, month, and year for the schedule by clicking the + sign in the Inclusion Periods box to specify the time period when you would like the system to apply the rule or rulebases depending on whether the conditions are met. Likewise, you can do the same by clicking the + sign in the Exclusions Periods when you would like the system to ignore the rules or rulebases.
7.
8.
(Optional) If you would like to deploy this schedule to another agent too, click Deploy To link and select the agents to which you would like to deploy the newly created schedule.
Importing and Exporting Schedules
You can export your existing schedules to a .hsf file on your local machine by clicking the Export Schedules link. This is helpful when you want to reuse the schedule on another agent. You can import your exported schedule into another agent by clicking the Import Schedules link on the Schedules page of the agent. It will save you the effort of recreating the schedules.

Copyright © Cloud Software Group, Inc. All Rights Reserved
Copyright © Cloud Software Group, Inc. All Rights Reserved