Getting Started With Fuse HQ

Version 4.4

April 2011
Legal Notices

Updated: 15 Apr 2011

Table of Contents

1. Introduction to Fuse HQ
Fuse HQ Capabilities
Setting up Fuse HQ
Opening the Fuse HQ Portal
2. Discovering Resources
Adding a Platform Resource
Adding Resources
3. Console Overview
Getting Around in Fuse HQ
The Dashboard and Other Views
Resource Pages

List of Figures

1.1. Fuse HQ Dashboard
1.2. Fuse HQ login prompt
3.1. Navigation controls
3.2. Dashboard Columns and Portlets
3.3. Resources View

List of Tables

3.1. Dashboard Portlets

The components of your system that Fuse HQ can monitor are called resources. From the resources available on your system, you choose the specific ones that you want to monitor. This set of resources is your inventory. The inventory comprises both basic resources and composite resources.

Basic resources include platforms, servers, and services.

You combine selected basic resources, according to your own criteria, to define and add to your inventory two types of composite resources: groups and applications.

You can log in to Fuse HQ from any machine, provided firewall settings allow HTTP communication between that machine and the Fuse HQ Server host. In the address field of your Web browser, enter the following URL:


This URL assumes that the Fuse HQ Server was installed with the default HTTP port, 7080. If not, substitute the correct port number. You can find this and other installation settings in the file hq-server-install.conf in the install_dir/data directory. The HTTP port setting appears in the file as server.webapp.port.

The Fuse HQ login prompt appears, as shown in Fuse HQ login prompt.

To log in for the first time, enter the administrator ID and password (both hqadmin by default) that were specified on installation of the Fuse HQ Server, and click LOGIN. The Fuse HQ Dashboard appears (Figure 1.1).

Among the user administration tasks you perform, you should change the as-installed administrator password before implementing Fuse HQ in a production environment.

This tutorial assumes the following starting point:

To add a platform resource to the set of resources monitored by the Fuse HQ Console, perform the following steps:

  1. On the host that you want to monitor, start the Fuse HQ Agent (the platform resource). See Starting and Stopping the Fuse HQ Agent in Installing Fuse HQ for details of how to start the Agent.

  2. The newly started agent is not visible right away on the console. The Agent must complete an initial scan before it appears on the console. Wait a few minutes (typically, 5 minutes, or more on some platforms), then click your browser's refresh button to renew the dashboard screen. If there is no change on the dashboard, wait a minute and try again. Keep refreshing until a new platform resource appears in the Auto-Discovery portlet on the dashboard, as follows:

  3. To start monitoring the newly-discovered platform resource, click .

This tutorial assumes the following starting point:

To add resources and view their properties in the Fuse HQ Console, perform the following steps:

  1. Start your application on the target host. In this example, we start a Fuse Message Broker 5.3.0 broker.

  2. From the dashboard, in the Recently Added portlet, identify the platform resource corresponding to the host where you intend to run your application. Click on the relevant hostname.

    For example, the following illustration shows the clickable platform resource, highlighted by a red rectangle:

    After clicking, you should see the Resources tab for the selected platform resource.

  3. In the Resources tab, locate the Map and Tools Menu drop-down menus, as shown:

    If you find that the Map graphic obscures your view of the Tools Menu drop-down menu, close the map by clicking the small button next to Map, , which is highlighted here in red.

  4. From the Tools Menu drop-down menu, select the New Auto-Discovery menu option:

  5. Directly under the Quick Auto-Discovery Scan title, click the green Ok button, as shown:

    The next screen that appears does not yet include the newly-started resources.


    You could use the Extended Filesystem Scan Configuration section to perform an additional filesystem scan and to restrict the server types that are scanned. But be careful: if you let the filesystem scan roam over your entire file system, the scan will take a very long time to complete.

  6. Click the Dashboard tab. Wait a few minutes (typically, 5 minutes, or more on some platforms), then click your browser's refresh button to renew the dashboard screen. If there is no change on the dashboard, wait a minute and try again. Keep refreshing until a new platform resource appears in the Auto-Discovery portlet on the dashboard, as follows:

    Click Add to Inventory.

  7. Under the Recently Added portlet, click the platform resource link for the host where the application is running. This brings you to the Resources tab for the chosen resource.

  8. Under the Monitor sub-tab of the Resources tab, you should now be able to see your newly-added resource. For example, if you added a Fuse Message Broker resource, you should see an ActiveMQ resource amongst those listed, as shown:

    Initially, the status of the newly-added resource is shown greyed-out. After a few minutes (refresh the browser, if necessary), its status turns to green and you can begin to monitor its properties.

    For a brief overview of how to monitor a resource's properties, see Console Overview.

Navigation controls shows examples of some of the controls described in the sections that follow.

The Dashboard (see Figure 1.1), the Fuse HQ home page, appears when you log in. Its purpose is to provide convenient access to the information you are most interested in. Therefore, you have considerable control of the content that appears on your Dashboard.

The Dashboard displays information in two columns, in frames called portlets (see Dashboard Columns and Portlets).

Dashboard Portlets summarizes the portlets that are available on the Dashboard.

Table 3.1. Dashboard Portlets


Search Resources

Lets you search for resources in the inventory by a string occurring in the resource name and by resource category.

Saved Charts

Lets you see a configurable slide show of graphical data for selected resources.

Recently Added

Lists platforms added to the inventory during the preceding 48 hours.

Availability Summary

Indicates the current availability of a user-selected set of resources. Entries in this list refer to resource types (for example, ActiveMQ 5.x-fuse Queue or Win32), with resources of like type automatically grouped.

For each resource type you select, an icon indicates one of five states: available (green), unavailable (red), partially available (yellow), paused (orange), or no data collected (gray). The number of resources of each type is also shown.

Summary Counts (hidden by default)

Displays the total number of resources that the user has permission to few, grouped by category and optionally subtotaled by specific resource type.



Lists resources reported by Fuse HQ Agents but not yet added to the inventory. You can select resources to add to or exclude from the inventory.

Favorite Resources

A user-selected list of any set of resources in the inventory.

Recent Alerts

A list of alerts that match a user-specified set of criteria for resources, severity, and time of occurrence. You can have multiple Recent Alerts portlets on your Dashboard, each with different criteria.

Control Actions

A list of actions performed via Fuse HQ on servers, services, and compatible groups in the inventory during a user-specified period ending with the present time. Each server or service type defines the control actions that are available for it.

Problem Resources

A list of resources that have encountered out-of-bounds conditions during a user-specified period ending with the present time. The administrator defines the conditions that are out of bounds by establishing baseline metrics for specific resources.

Metric Viewer (hidden by default)

A list of user-selected metrics for selected resources. You can have multiple Metric Viewer portlets on your Dashboard, each with different criteria.

To go to the Resources view from the Dashboard (or from most other Fuse HQ screens), hover the cursor over the Resources tab on the black strip near the top. Then select Browse from the drop-down menu. (Alternatively, you can select the self-explanatory options Currently Down or Recently Viewed.)

The Resources view provides comprehensive lists of resources in the inventory, filtered by category and optionally by type. For example, Resources View shows the Resources view filtered to show all servers.

At the top of the shaded list area, the Resources view shows the current inventory count for each resource category (Platforms, Servers, Services, Compatible Groups/Clusters, Mixed Groups, Applications). Click any of these categories to show the resources in that category. To further filter the results, select a resource type from the drop-down list in the View field.

To view the list with graphical representations of the available metrics for each resource, click Chart View. Switch back to the simple text list by clicking List View.

To locate specific resources, enter all or part of the name in the Search field and click the arrow button to the right. Note that performing a search filters the lists for all resource categories. Therefore, for example, if you search for a given string in the Services list and then switch to the Servers list, you might see few or no entries. This is because the list of servers is filtered to show only those results that match the search criteria. To remove the search filter and show all items in the resource category, clear the Search field and click the arrow button again.

Often you will want to proceed from the Resources view to see detailed information about a specific resource. Clicking a button to the left of each name takes you quickly to a specific tab on the resource page for that item: M for the Monitor tab, I for the Inventory tab, or A for the Alerts tab. Clicking the name itself takes you to the Monitor tab. See Resource Pages for more information.

The Resources view also lets you perform important inventory-management tasks: defining groups and applications, and removing resources from the inventory.

To group or delete resources, select them by clicking their check boxes at the left. (To select or deselect all items in the current list, click the check box in the list header row.) Then click the Group or Delete button. (Note that deleting a resource removes it from the inventory, but has no effect on the resource itself. If you decide to add a resource back to the inventory after deleting it, you can perform a new auto-discovery on its host platform.)

To define applications, click Tools Menu at the top right and select New Application. This menu also gives you another way to define groups, and an option to manually add certain types of platforms.

For every resource in the inventory, Fuse HQ presents detailed information in a set of tabbed pages. The available tabs and their content depend on the nature of the resource in question, but all basic resources (platforms, servers, and services) and compatible groups have a Monitor tab, an Inventory tab, and an Alert tab. Mixed groups and applications do not have all of these tabs.

Resources that allow control actions have a Control tab that provides access to these actions. For example, the Control tab for a Fuse Message Broker queue lets you send a text message to the queue.

Clicking any resource name almost anywhere in Fuse HQ takes you directly to the Monitor tab for that resource. (There are a couple of exceptions: Clicking a platform name in the Auto-Discovery portlet takes you to the Auto-Discovery Results screen for that platform; and clicking the name of a mixed group, which does not have a Monitor tab, takes you to the corresponding Inventory tab.)

These pages are designed to help you navigate easily through the hierarchical structure that includes the resource. In the top left corner of every page is a Map button. Clicking this button reveals a tree diagram showing the current resource along with the other resources associated with it. In general, "parents" appear below and "children" appear above the current resource, as applicable. For example, in the map tree for a server, the host platform (parent) appears below the server, and hosted services (children) appear above. You can click any resource in the tree to go to the resource pages for that item.

The Tools Menu at the top right of each page provides options appropriate to the current resource type.

A prominent label at the top right identifies the resource category of the current item: platform, server, service, group, or application.

The Monitor tab, also called the Current Health screen, provides the most detailed information available about the performance and activity of a given resource. The right column of this page offers both graphical and numerical displays of metric data collected from the resource during a specified time period. The left column, headed by a sub-tab labeled Resources, shows resources related to the current one and provides controls for specifying which metrics are charted in the graphical display.

In the right column, to switch between the graphical and numerical displays, click the Indicators and Metric Data sub-tabs. To see a full-size chart for any individual metric, click the metric name on either tab.

On the Indicators sub-tab:

Column charts appear for each selected metric. The horizontal axis is a time line that applies to all charts in the display. Click a circle in the row either above or below the charts to highlight and display the precise time of a specific point on the axis.

The colors of the circles in the top row indicate availability, as follows: green, 100 percent available; yellow, partially available; red, unavailable; orange, paused; and gray, no data collected.

If log tracking is enabled for the resource, a blue square appears just above the bottom row of circles for any time segment during which Fuse HQ has recorded an event. Click the blue square to display the available log messages.

You can remove and rearrange the charts, and save any configuration as a custom view that is specific to the current resource. To move a chart up or down in the column, use the and buttons above the top right corner of the chart; to remove the chart from the column, click the button. To save the current view, select Create New View in the View field at the top right corner of the display area, enter a name, and click .

On the Metric Data sub-tab:

Metric values are shown in a tabular format. Various controls allow you to specify the refresh rate, the data collection interval, and other settings. You can select one or multiple metrics in the table and click Chart Selected Metrics to display a full-size chart.

The Metric Data tab offers a convenient way to establish baselines, which are useful for defining alerts and tracking trends, among other purposes. To automatically set the baselines for one or more metrics to the LOW, PEAK, and AVG values currently shown, select the metrics and click Set Baselines.


Additional baseline-setting controls appear at the bottom of each full-size chart (provided the chart shows only a single metric).

On the Resources tab:

The related child and parent resources of the current resource are listed. To the right of each related resource name is an availability indicator and a balloon icon. Hover the cursor over the balloon to display a popup window with additional information (and, in some cases, active links) pertaining to the resource.

The other options available on the Resources tab vary according to which tab is selected in the right column. With the Indicators tab open, you can use the available controls to add charts for metrics of these related resources to the display in the right column. With the Metric Data tab open, you can filter the metrics that appear in the table.

To add metrics for a related resource, select the Indicators tab on the right. Then, in the left column, check the related resources for which you want to see metrics, and click View Metrics. The metrics collected from the selected resource appear in a list below. You can then add a chart for any of these metrics to the Indicators tab by clicking the right arrow button to the right of the metric. Remember that you have the option of saving any set of charts on the Indicators tab as a view that you can recall whenever you are monitoring the current resource.

To filter the display on the Metric Data tab, check the desired categories and types, enter a search string if desired, and click the right arrow button to the right of the Search field.