Hyperic HQ is an open source, enterprise-level systems monitoring tool that Navis requires for
monitoring Java Virtual Machine (JVM) processes. Your installation files include a SPARCS N4-specific plug-in for Hyperic that allows Hyperic agents to quickly discover SPARCS N4 components. You can collect basic metrics for the SPARCS N4 components, including XPS and the second-level cache (Coherence). You can also use the Hyperic plug-in to develop more detailed dashboards and parse log files.
As with previous releases, Navis has enabled Java Management Extensions (JMX) by default for all components that are java processes (SPARCS N4, the Bridge daemon, and ECN4). JMX lets you monitor memory and thread usage, and provides other diagnostic options, such as a detailed view of all available MBeans.
Hyperic installation tasks:
1
Ensure the environment meets the requirements, and gather the required files.See Requirements for installing Hyperic (on page 175).
2
Get the Hyperic installer.See Select and download a Hyperic installer (on page 177).
3
Install the Hyperic server.See Steps to install the Hyperic server (on page 177).
4
Install the plug-in for Hyperic.See Steps to install the Navis Hyperic plug-in (on page 179).
5
Install the Hyperic agents on the SPARCS N4 component hosts.See Steps to install Hyperic agents (on page 180).
6
Verify that the Hyperic installation was successful.See Verify the Hyperic installation (on page 181).
7
Orient yourself within Hyperic.See Get started monitoring SPARCS N4 with Hyperic (on page 181).
Requirements for installing Hyperic
The SPARCS N4 plug-in is fully compatible with both the open source and enterprise versions of Hyperic
SPARCS N4: Installation Guide 2.4 175
4.6.6 with SPARCS N4. The version you select depends on your operation. Review the feature sets on the Hyperic website. The open-source version is more than adequate for a mid-sized terminal (400,000-700,000 Annual TEU) with one yard. If you have a multi-terminal complex, Navis recommends the Enterprise version, because it offers role-based security.
See
http://support.hyperic.com/display/EVO/Supported+Configurations+and+System+Req uirements for more information.
The following items are required for installing Hyperic:
Dedicated host for Hyperic application and the Hyperic database (both can run on the same host). The minimum specifications are as follows for up to 500 managed platforms:
Processor Speed: 4 or more server-class CPUs, 2 GHz or better
RAM: 8 GB
Free disk space: 20 GB Important constraints:
Hyperic supports only one Hyperic server on a host. The host must have a static IP address for server communications.
Hyperic supports only one Hyperic agent on a host.
If you manage more than 100 hosts in your environment, run the Hyperic database on a dedicated host, rather than on the same host as the Hyperic server.
Hyperic 4.6.6 - Note that there is no 64-bit version of Hyperic for Windows. The 32-bit version runs reliably in WoW64 (a subsystem of the Windows OS that is capable of running 32-bit applications and is included on all 64-bit versions of Windows).
You can download either a tar.gz file or a .zip file.
Java Runtime Environment (JRE) 1.6. Note that platform-specific Hyperic installers include a 1.6 JRE.
Use the no-JRE server installer if you prefer to use an existing JRE in your environment, or if no platform-specific package is available.
Hyperic does not support 64-bit JREs under Windows. Use the 32-bit installer package for Windows, or the platform-independent installer if you prefer to use a pre-existing JRE in your environment. If you do use a JRE of your own, see JRE location for Hyperic (on page 179) for information about how to ensure that Hyperic uses the right JRE.
MySQL or Oracle database for Hyperic -- Hyperic currently supports:
MySQL versions 5.0 and 5.1 - The essentials (GPL License) is sufficient, but customers should check the license to confirm that usage is within the GPL license term.
Oracle versions 10g and 11g - Navis does not have a licensing recommendation at this time.
Navis does not recommend you use Hyperic's built-in database. Hyperic says it is only for demo purposes, and Navis has determined that it is not robust enough to monitor a SPARCS N4 system.
The correct database driver for your database:
Oracle - ojdbc6
MySQL - Connector/J
176 SPARCS N4: Installation Guide 2.4
Select and download a Hyperic installer
Download the Hyperic install package from http://sourceforge.net/projects/hyperic-hq/files/Hyperic%204.6.6/
Navis has collected the following common questions and answers that might come up when you download the Hyperic package:
Is the JRE included in the Hyperic installation package?
Most Hyperic installation packages include 1.6 JREs, for both the Hyperic server and the Hyperic agent.
Hyperic installers referred to as independent do not include a JRE — use a
platform-independent package if you have a pre-existing JRE on the target platform that you want the server or agent to use. A platform-independent package for Unix-like environments is also appropriate if there is no Hyperic installer for your operating system.
What is vFabric, and how is it different from Hyperic HQ 4.6.6?
vFabric Hyperic is the commercial version of the Hyperic product, available as part of a vFabric Cloud Application Platform package and as a standalone product. Hyperic HQ is the open-source version of Hyperic. The products have many similarities, although vFabric Hyperic has a number of features that the open source offering does not.
As a general rule in documentation text, "Hyperic" is used in contexts that apply to both vFabric Hyperic and Hyperic HQ. "vFabric Hyperic" and "Hyperic HQ" (or "HQ") are used in contexts that apply
specifically to one product or the other. Exceptions include titles of Hyperic guides, which refer to vFabric Hyperic, and some "HQ" references in the user interface and code that apply to both products.
Are database drivers included in the Hyperic installation package?
Only the commercial version of the Hyperic product, vFabric Hyperic, includes the database drivers in the installation package. For Hyperic HQ, you must get the appropriate driver directly from the database vendor. See Requirements for installing Hyperic (on page 175).
Steps to install the Hyperic server
You install Hyperic after you install the SPARCS N4 components.
During the installation, you will be asked for the following information, so you should have it ready:
Whether to install the server component or the agent component.
The Hyperic server installation path: (Enter 'C:\Hyperic')
The fully qualified domain name of the SMTP server that Hyperic will use to sent email messages:Enter 'smpt.[hostname]'
The type of database you are using. (Your options are Oracle or MySQL Enterprise/Community Server 5)
The email address that Hyperic will use as the sender for email messages.
Whether to use an auto-generated encryption key to encrypt the database password.SPARCS N4: Installation Guide 2.4 177
The database administrator's username and password.
The database host name, port, and service ID (SID).
Whether to override the JDBC Connection URL. (If you want to use an alternative driver, you can enter it.)
The username and password for the initial Hyperic administrative user.
The email address for the initial Hyperic administrative user.To Install the Hyperic server:
1 Download the Hyperic server: http://sourceforge.net/projects/hyperic-hq/files/Hyperic%204.6.6/ See Select and download a Hyperic installer (on page 177) for more information.
2 Set up the Hyperic database. Refer to Hyperic documentation for set-up instructions:
http://support.hyperic.com/dashboard.action
Make a note of the JDBC URL, database username, and database password—these values are required when you set up the Hyperic server.
3 Configure the Hyperic database start-up options and system variables.
For MySQL, see http://support.hyperic.com/display/DOC/Set+Up+MySQL or
http://pubs.vmware.com/vfabric5/topic/com.vmware.vfabric.hyperic.4.6/Set_Up_MySQL.html
For Oracle, see http://support.hyperic.com/display/DOC/Set+Up+Oracle or
http://pubs.vmware.com/vfabric5/topic/com.vmware.vfabric.hyperic.4.6/Set_Up_Oracle.html 4 Install Hyperic server application on the Hyperic host:
You can install the Hyperic server on the same host as the Hyperic database.
a. Run a command prompt tool as an administrator and create the directory C:\Hyperic b. Extract the install folder to a secure location.
c. Navigate to the folder where you put the extraction.
Ignore any errors related to not finding the tools.jar file.
5 The Hyperic setup prompts you for the items listed in the checklist above.
The installation proceeds. Success provides: 'Server successfully installed to C:\Hyperic\server-4.6.6'
6 Using the command line, install the Hyperic server as a Windows service using this command:
C:\Hyperic\server-4.6.6\bin\hq-server.bat install
Success provides 'wrapper | Hyperic HQ Server service installed.' 7 Start the service for Hyperic:
a. From the Windows task bar on the Hyperic host, click the Server Manager button . b. In the Server Manager, under Configuration in the left frame, select Services. The installed
services display in the right frame.
c. In the list of installed services, find the Hyperic HQ Server service, and right click. From the drop-down list that appears, select Start. A progress bar appears.
178 SPARCS N4: Installation Guide 2.4
When the Status column says Started, the Hyperic server is running.
d. Wait 1 minute, and refresh the Services window.
If the Status column still says Started, move to the next step.
If the Status column is empty, something is wrong with the configuration. Check the log file.
8 Test the connection. From a workstation, open a browser window to test the connection:
http://[hostname]:7080/
Log in with the username and password you specified. The Hyperic Dashboard should appear.
(There are not any resources in inventory until you start a Hyperic agent.) If the Hyperic Dashboard does not appear, check server.log and boostrap.log in ServerHome/logs/ for information about server startup status.
Next Step: Install the Navis plug-in for Hyperic (on page 179).
JRE location for Hyperic
If you are installing a Hyperic component from a package with a bundled JRE on a system that has a pre-existing JRE, the component should be able to resolve its JRE. However, you may need to set the
HQ_JAVA_HOME environment variable if you have an application on the same host that uses another version of the JRE.
The Hyperic server and the Hyperic agents reference the JRE differently.
The order of preference when resolving the Hyperic server's JRE is:
1 HQ_JAVA_HOME environment variable 2 Embedded JRE
3 JAVA_HOME environment variable
When installing the Hyperic server with a platform-independent installer, make sure that your JAVA_HOME environment variable points to your pre-existing JRE. If you install the Hyperic server from a package with an embedded JRE, and you want the server to use a different JRE on the host, set HQ_JAVA_HOME to point to the desired JRE.
The order of preference when resolving the Hyperic agent's JRE is:
1 HQ_JAVA_HOME system variable (not an environment variable) 2 Embedded JRE
To run a Hyperic 4.x agent under Windows, you must set HQ_JAVA_HOME as as a system variable:
My Computer Properties Advanced Environment Variables System variables New
Steps to install the Navis Hyperic plug-in
When you have finished installing the Hyperic server, you install the Navis plug-in for Hyperic.
To install the Navis plug-in for Hyperic:
1 Get the Navis plug-in for Hyperic from your SPARCS N4 installers package (navis-plugin.jar) and put it somewhere on the Hyperic host.
2 Log in to Hyperic, and go to the Administration tab and click the Plugin Manager link.
SPARCS N4: Installation Guide 2.4 179
3 Click the Add/Update Plugin(s) button , and navigate to the SPARCS N4 Hyperic plug-in (navis-plugin.jar).
4 Click Upload.
5 Restart Hyperic.
Next Step: Install the Hyperic agents on the SPARCS N4 component hosts (on page 180).
Steps to install Hyperic agents
When you have finished installing the Hyperic server and the Navis plug-in for Hyperic, you must install the Hyperic agents on each of the SPARCS N4 component hosts:
Center Node and Standby Center Node hosts
Cluster Node hosts
XPS/Bridge host
ECN4/ECN4Web host
The Hyperic server must be running to install the Hyperic agents.
During the installation, you will be asked for the following information, so you should have it ready:
The IP address for the host of the Hyperic server.
The username and password for the initial Hyperic administrative user.To install the Hyperic agent on a SPARCS N4 component host:
1 Verify or create the JAVA_HOME or HQ_JAVA_HOME variable. (You can use the same JRE that you are using for your Navis component). See JRE location for Hyperic (on page 179) for details.
2 Run a command prompt tool as an administrator and create the directory C:\HQagent This directory name must not contain any spaces.
180 SPARCS N4: Installation Guide 2.4
3 Place the Hyperic agent (hyperic hq agent 4.6.6) in the directory you just created.
Verify the agent version is the same as the application server.
4 Open a command prompt window, and navigate to the batch file (hq-agent.bat) in the bin folder where you placed the Hyperic agent.
5 In the command prompt, enter 'hq-agent.bat install'. Success provides, "service installed"
6 Again in the command prompt, enter 'hq-agent.bat start'. This batch file starts the service for the first time, and then prompts you to configure it. Enter the IP address, login, and password to the Hyperic server. Respond to the other questions as needed.
If the Hyperic server is unreachable, the installation cannot proceed.
If you see errors, refer to the Troubleshooting section (on page 185).
7 Repeat on the other SPARCS N4 component hosts.
Next Step: Verify the Hyperic installation (on page 181).
Verify the Hyperic installation
When you have installed the Hyperic server, the Navis plug-in for Hyperic, and the Hyperic agents on all of the SPARCS N4 component hosts, you can verify the Hyperic installation.
It takes about 10 minutes after installation for each the Hyperic agents to appear in the Hyperic interface.
To verify the Hyperic installation:
1 Start up the SPARCS N4 system.
You must start the SPARCS N4 system in a specific order. For instructions, see Sequence the start-up fo rthe SPARCS N4 components (on page 155).
2 From a network workstation, log in to Hyperic: http://[hostname]:7080/
3 In Hyperic, navigate to the Dashboard tab. Verify that Hyperic discovered all of the SPARCS N4 services that are running, and add them to the Hyperic inventory.
Next Step: Get started monitoring SPARCS N4 with Hyperic (on page 181).
Get started monitoring SPARCS N4 with Hyperic
The first screen you see in Hyperic after installing is the Dashboard. You customize this dashboard with relevant information from you SPARCS N4 components. The image below shows a dashboard for a SPARCS N4 system.
The grey header bars split the view into different 'portlets,' which you can choose and personalize. The example dashboard shows the following portlets:
SPARCS N4: Installation Guide 2.4 181
Search Resources: Find resources by name.
Saved Charts: Add links to your favorite charts by navigating to them and clicking the "Save Chart to My Dashboard" link.
Recently Added: View a list of resources recently added to Hyperic's inventory.
Availability Summary: See at-a-glance whether resources are up or down. Add resources by clicking the gear icon.
Auto Discovery: View newly discovered resources. Add them to the inventory using a button that appears when there are records present.
Favorite Resources: Add links to your favorite resources by clicking the gear icon.
Recent Alerts: View the five most recent alerts from the last day. Adjust the length of time and number of alerts by clicking the gear icon.
Control Actions: View the most recent control actions that have been triggered.
Other options are:
Metric Viewer: Add your favorite metrics to monitor by clicking the gear icon.
Summary Counts: View a count of the different kinds of resources that Hyperic is monitoring.
Example Dashboard:
Note that when you first install agents on SPARCS N4 component hosts, you will only see those hosts in the Auto-Discovery portlet that appears on the Dashboard by default. When there are newly auto-discovered hosts, you can add them to the Hyperic inventory using a button that appears in the Auto-Discovery portlet. Once added, it is called a Hyperic 'resource'. You then configure your resources in the Hyperic inventory to enable monitoring. Configurations options are on the resource's Inventory page.
182 SPARCS N4: Installation Guide 2.4
See the Hyperic documentation for a thorough introduction:
http://pubs.vmware.com/vfabric52/topic/com.vmware.vfabric.hyperic.4.6/Introduc tion_to_the_Hyperic_Dashboard.html
SPARCS N4: Installation Guide 2.4 183