Getting Started with the Hyperic User Interface

After you install and start the Hyperic Server and all the agents on all computers that host tc Runtime instances, you invoke the Hyperic user interface in your browser so that you can start using it to monitor and configure tc Runtime instances, as well as other resources.

The following procedure describes how to access the Hyperic user interface, add a tc Runtime instance to the Hyperic inventory, and update the tc Runtime instance JMX configuration properties so that Hyperic can manage them.

  1. Invoke the Hyperic user interface in your browser:



    • host is the computer on which you installed the Hyperic Server. If your browser is running on the same computer as the Hyperic Server, you can use localhost or

    • port is the TCP/IP listen port of the Hyperic Server, specified when you installed the server. The default value is 7080.

      The TCP/IP listen port is configured in the HQ_SERVER/conf/hq-server.conf file, where HQ_SERVER is the directory in which you installed the Hyperic Server. If the default listen port does not work, search this file for the actual value of the server.webapp.port property.

    For example, use the following URL if Hyperic server is running locally using the default listen port:

  2. At the login screen, enter the administrator login. The default username is hqadmin, with password hqadmin.

    The server administrator username and password are configured in the HQ_SERVER/data/hq-server-install.conf file, where HQ_SERVER is the directory in which you installed the Hyperic Server. If the default values do not work, search this file for the actual values of the server.admin.username and server.admin.password properties.

    Important: As is true for all default passwords, be sure to change it as soon as possible to ensure maximum security for your installation.

  3. Select a default dashboard for the administration user; this selection affects only the appearance of the Hyperic user interface, not its functionality. VMware recommends you select hqadmin then click OK. You can change the default dashboard after you log in.

  4. The following graphic displays the main Hyperic dashboard. Highlighted objects are ones that you always use or use when you get started; see the explanation for each object after the graphic.

    • The two Dashboard links return you to this main dashboard console page.

    • The Resources link allows you to browse the full set of resources known by Hyperic, quickly scan the resources that are currently down, or easily go to the resources you have most recently viewed.

    • The Auto-Discovery Portlet shows resources that Hyperic has auto-discovered but you have not yet worked with (either adding them to the Hyperic inventory or skipping them). For example, if you start a tc Runtime instance before logging into Hyperic, then the instance automatically shows up in the auto-discovery portlet. In the next step you will add these resources to Hyperic's inventory.

      The Hyperic UI itself uses a tc Runtime internally called hq-server, which is also listed in the Auto-Discovery portlet.

    • The Help button provides context-sensitive online help, with useful information about what tasks you can perform on each Hyperic user interface page.

  5. Import your operating system platform, the tc Runtime instance, and other resources running on the platform into the Hyperic inventory by selecting the appropriate radio buttons next to the resource in the Auto-Discovery portlet and clicking Add to Inventory, as shown in the following graphic.

    The tc Runtime instance shows up as platform-resource tc Runtime catalina-base-dir in the Hyperic user interface, where platform-resource refers to the computer on which the instance is running and catalina-base-dir refers to the CATALINA_BASE directory of the tc Runtime instance without the leading directory pathnames. For example: my-desktop tc Runtime myserver. The Hyperic Agent might also show up in the auto-discovery portlet, listed as HQ Agent 4.6.X.X-EE.

    Because of the auto-discovery feature of Hyperic, your operating system platform should automatically show up in the Auto-Discovery portlet on the main Dashboard screen of the Hyperic user interface. Other resources running on the operating system, such as other tc Runtime instances, will also show up in the portlet. This is true for all computers running Hyperic agents that communicate with this Hyperic Server.


    It can sometimes take a few minutes for a newly-started resource, such as the tc Runtime instance, to show up in the auto-discovery portlet.

    After you click Add to Inventory, selected resources show up in the Recently Added portlet of the main Dashboard.

  6. Click the Resources > Browse link at the top of the Hyperic user interface.

    This brings you to a console page from which you can view all the resources in the Hyperic inventory. You view the tc Runtime instances by clicking on the Servers (X) link, as shown:

  7. Click the Servers (X) link. A list of all the servers in your inventory appears in the table. The tc Runtime instances are listed as platform-resource tc Runtime catalina-base-dir.

  8. In the table, click on the tc Runtime instance you just added to the Hyperic inventory, as shown in the preceding graphic.

    Hyperic displays the configuration and management pages of a tc Runtime instance, as shown in the next graphic and ensuing explanation.

    • Monitor tab. Displays monitoring information about a tc Runtime instance and its services, such as the deadlocks detected, available heap memory, and so on. The charts show either graphical or tabular data about the metrics; click Indicators or Metric Data to view each kind of data. Click a particular service in the Services table to view diagnostic information about that particular service that is associated with the tc Runtime instance.

    • Inventory tab. View and manage the tc Runtime instance's general properties, the services hosted by the server, groups containing the server, and the server's monitoring and control configuration.

    • Alert tab. View, configure, and create alerts for a tc Runtime instance.

    • Control tab. Start, stop, and restart this tc Runtime instance, as well as schedule one of these actions for a future date.

    • Views tab. Has two subtabs: Server Configuration and Application Management. Use the Server Configuration tab to configure the tc Runtime instance, such as startup JVM parameters, JSP behavior, and properties of the Catalina service, such as connectors and engines. The application deployment tab allows you to deploy Web applications to the tc Runtime instance, as well as start, stop, reload, and undeploy already deployed Web applications.

  9. Click the Inventory tab.

  10. Scroll down to the Configuration Properties section.

    The Hyperic user interface uses the values of the fields in this section to connect to the tc Runtime instance, control it, and so on. In particular, the Shared section specifies the JMX properties of the tc Runtime instance; Hyperic uses JMX to configure and manage tc Runtime instances.


    If you have not changed the JMX values in server.xml, Hyperic will populate these fields automatically, so the tc Runtime instance should work with Hyperic without change. However, if you have changed the JMX values of your tc Runtime instance by manually updating its server.xml file, then you must change the corresponding fields in the Hyperic user interface, as described in the following procedure.

    1. Click Edit.

    2. Update the following fields as required:

      • jmx.url: URL that the Hyperic user interface uses to connect to the JMX server associated with the tc Runtime instance. The format is service:jmx:rmi:///jndi/rmi://host:jmxport/jmxrmi. Be sure the value of host is the name of the computer on which the JMX server is running (you can use localhost if it is the same as the computer hosting Hyperic server) and that the value of jmxport is the value of the port attribute of the <Listener> element in the tc Runtime instance's server.xml file that corresponds to the com.springsource.tcserver.serviceability.rmi.JmxSocketListener class (default value is 6969).

      • jmx.username: JMX username that Hyperic uses to connect to the JMX server associated with the tc Runtime instance. The username is stored in the file pointed to by the passwordFile attribute of the <Listener> element in the tc Runtime instance's server.xml file that corresponds to the com.springsource.tcserver.serviceability.rmi.JmxSocketListener class; by default, the name of this file is CATALINA_BASE/conf/jmxremote.password. The default username is admin.

      • jmx.password: Password of jmx.username. The password is stored in the same file as the username, as described in the preceding bullet. The default password is springsource.

    3. Click OK.

You are now ready to monitor and configure the tc Runtime instance using Hyperic. For a tutorial that describes how to perform common management and configuration tasks using Hyperic, see Tutorial: Using Hyperic to Configure and Manage tc Runtime Instances.

For detailed conceptual and task information about using Hyperic, click the Help button on the Hyperic user interface or consult the vFabric Hyperic documentation.