Report Center

Available only in vFabric Hyperic

This page describes the Report Center page in the VMware vFabric™ Hyperic® user interface.

Report Center Overview

vFabric Hyperic's Report Center has built-in reports that provide visibility into availability, alerts, inventory, resource utilization, and resources that are not collecting metrics. You can also create your own reports. Report Center reports can accept parameter values, and be generated in PDF, HTML, Excel, and CSV formats.

Report Center Requires Super User Role

Only a user with the Super User role may run reports in the Report Center. For information about roles, see User Accounts and Roles in Hyperic.

Navigate to the Report Center

Click Analyze > Report Center.

Built-In Reports

The table below describes the ready-to-run reports in the Report Center. Hyperic provides the following report templates:

Report Template

What Does It Tell Me?

What The Report Displays

Required User Input (Parameters)

Sample Report

Alert Detail

Which resources in my environment are firing the most alerts?

The same as the Alert Summary Report, except, instead of a summary of alerts, every alert is shown. This is useful when analyzing a full alert log.

Start Date
End Date
Group

Alert Detail Report.png

Alert Summary

Which resources in my environment are firing the most alerts?

A summary of all alerts that were triggered during the user-specified time range. You can restrict the list of alerts by a user-specified group. For each resource, the number of low-, medium-, and high-priority alerts are shown, along with the total number of alerts.

Start Date
End Date
Group

Alert Summary Report.png

Availability Downtime

How many minutes were resources unavailable over the given time range?

Availability percentage and minutes of downtime, over a user-specified time range, for resources in a user-specified group. This report cannot be run against the entire environment.

Start Date
End Date
Group

Availability Downtime Report.png

Disk Usage

Which disks are running low on free space?
Which disks are filling up the quickest?

Disks in the environment that are running low on free space, over a user-specified time range. This report can be run against a single group or across the entire environment.

Start Date
End Date
Group

Disk Usage Report.png

Inventory

What resources were created during the given time range?
What new services have been discovered? (Hyperic auto-imports services and so they are not immediately obvious.)

All resources created in the Hyperic environment in the user-specified time range, sorted by creation date. This report operates on the entire environment.

Start Date
End Date

Inventory Report.png

Event Log Summary

What's happening on each of my resources? A summary of events across all resources, instead of for a single resource.

Resources and their logged events, taken from the system's event logs, sorted by the number of events.

Start Date
End Date

Event Log Summary.png

License Count

The platforms for which I have Hyperic licenses.

Platform name, type, license count, and date added.

No user input

License Count.png

Metric Interval

How many metrics are being collected on my resources, how often, and when? Basically, the report shows the metric load.

The collection interval and the number of metrics that are being collected for each resource.

No user input

Metric Interval Report.png

Network Interface

What kind of traffic are my resources experiencing?

Bits in/out per second for each resource

Start Date
End Date
Group

Network Interface Report.png

Resources Not Collecting Metrics

For which of my resources are metrics are no longer being reported, even though they're supposed to be?

Resources that have stopped publishing metrics, plus the last time a metric was recorded for the resource

No user input

Resources Not Collecting Metrics.png

Resources Without Metrics

Which of my resources don't have metric collection enabled?

Resources that don't have metric collection enabled in Hyperic

No user input

Resources Without Metrics.png

Unconfigured Resources

Which of my resources are not configured for management? For instance, Oracle needs a password, so when it is discovered and imported, metrics will not be collected until the password is provided.

 

No user input

 

* For reports involving specific resource types (for example, the Disk Usage and Network Usage reports include only "File Server Mount" resources), only compatible groups of that resource type are allowed as an input parameter. For all non-resource-type-specific reports (for example, the Alert and Availability reports), all groups defined in Hyperic are available for selection.

Custom Reports

If you need reports that Hyperic does not provide, you can write your own. Report Center is based on JasperReports, and the templates are written in JasperReports' XML format, JRXML. To write a report template, Hyperic suggests you use the Java-based application IReport (download it). Custom report templates must be in either JRXML format (generated from the content created in iReport) or compiled .jasper format. At this time compiled .jasper format is the only format supported when deploying new templates to Hyperic.

For help with JasperReports and iReport, consult their documentation:

Requirements for Writing Custom Report Templates

Because Hyperic's reporting functionality uses JasperReports and only supports reporting generation using SQL queries against the Hyperic database, writing custom report templates requires familiarity with both JasperReports and the Hyperic database schema. Assistance with the creation of custom Reports may be provided by our Professional Services Organization. Please contact your sales account representative.

Running SQL against the production Hyperic database is not recommended, as it may have an impact on performance or compromise database integrity. An inefficient or improperly configured report query could compromise the database or affect performance.

The best practice is to run reports in a test environment during development and against a replicated production database.

To incorporate a new report template into Report Center

  1. Write a report template in JRXML or compiled Jasper format, being sure to specify any user-input parameters necessary for generating the report (for example, a date range).

  2. Place the template (.jasper format only) in /hq-engine/hq-server/webapps/ROOT/WEB-INF/reportTemplates.

  3. Log out of Hyperic and log back in, the report will appear in the report list.

Specifying Report Description and Report Parameters

In the JasperReport file for a report:

  • Use a <property> element to define a description for the report. The text you specify will appear as the Report Description when you select a report on the Report Center page

Use a <parameter> element to specify a report parameter. When you run the report, you will be queried to supply the parameter value. The following parameter types are supported:

  • java.util.Date

  • java.util.String