Reporting Features in Windows HPC Server 2008 R2

Windows HPC Server 2008 R2 provides the following items that you can use to get information about jobs, nodes, and metrics for custom reports:

  • SQL Views

  • HPC cmdlets for the Windows PowerShell command-line interface

Note  The data that Windows HPC Server 2008 R2 provides through these two sources is not updated in real time and is subject to some latency. For Windows HPC Server 2008 R2, the HPC Reporting Service collects data every 15 minutes when the service is running, so the latency can be up to 15 minutes.

 

SQL Views

The main source of data that Windows HPC Server 2008 R2 provides for creating custom reports consists of a set of views in the HPCReporting SQL database for the HPC cluster. These views contain information about the jobs that have run on the cluster, the nodes and node groups in the cluster, changes in the state of the nodes, and the allocation of jobs to the nodes.

For reference information about each of the SQL views in the HPCReporting SQL database, see Reporting Views.

HPC cmdlets

Windows HPC Server 2008 R2 provides cmdlets that you can use to get data for custom reports and to view and set configuration properties for the reporting database.

The following table lists the cmdlets that you can use to get data for custom reports.

Cmdlet Description

Get-HpcJobHistory

Gets the job history data for all finished, canceled, and failed jobs for the specified time period. You can export this information to a database, and then create and run reports about the information.

Includes StartDate and EndDate parameters that you can use to specify the period of time for which you want to get job history data. Specifically, Get-HpcJobHistory gets job history data for jobs where the EventTime value for the job is between StartDate and EndDate.

Note  

The data that this command retrieves is similar to the data in the JobHistoryView in the HPCReporting database.

 

Get-HpcNodeStateHistory

Retrieves the history of changes to the state of the nodes in the HPC cluster for the specified time period. These changes include the addition and removal of nodes, and changes of the node state to Online, Offline, Reachable, or Unreachable.

Includes StartDate and EndDate parameters that you can use to specify the period of time for which you want to get node state data.

Note  

The data that this command retrieves is similar to the data in the NodeEventHistoryView in the HPCReporting database.

 

Get-HpcMetricValueHistory

Gets the historical values of the specified metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts.

Includes StartDate and EndDate parameters that you can use to specify the period of time for which you want to get metric values, a MetricName parameter that you can use to specify the metrics for which you want to get values, a Counter parameter that you can use to specify the counters for which you want to get values, and Node and NodeName parameters that you can use to specify the nodes for which you want to get metric values. A single metric can contain multiple counters. The StartDate and EndDate parameters are required, and the other parameters are optional.

Note  

This cmdlet does not correspond to a view in the HPCReporting database.

 

 

Note  

If you run the HPC cmdlets on a computer that only has the Windows HPC Server 2008 R2 client components installed and is not a member of an HPC cluster, include the Scheduler parameter in the cmdlet to specific the head node of the HPC cluster for which you want to get information.

 

Configuration parameters for the reporting database

You can use configuration parameters to view or change if and how long the reporting database stores information about jobs and nodes for reporting. You can view the values of the parameters with the Get-HPCClusterProperty cmdlet and set the values with the Set-HpcClusterProperty cmdlet. The following table lists the configuration parameters that are available in Windows HPC Server 2008 R2.

Parameter Description

AllocationHistoryTtl

Specifies the number of days that the HPCReporting database should store information about the allocation of jobs to nodes. This parameter has a default value of 5.

DataExtensibilityEnabled

Specifies whether the cluster stores information for custom reporting about jobs, nodes, and the allocation of jobs to nodes.

True indicates that the cluster stores information for custom reporting about jobs, nodes, and the allocation of jobs to nodes. False indicates that the cluster does not store this information. The default value is True.

DataExtensibilityTtl

Specifies the number of days that the HPCReporting database should store all of the information about jobs and nodes except for the allocation of jobs to nodes. This parameter has a default value of 365.

ReportingDBSize

Contains the current size of the reporting database. This value is a string that includes the units of measurement for the size. This parameter is read-only.

 

To view the current value of a configuration parameter, run the following cmdlet:

Get-HpcClusterProperty -Parameter -Name Parameter_Name

To change the value of a configuration parameter, run the following cmdlet:

Set-HpcClusterProperty -Parameter_Name New_Value

Note  

You cannot use the Set-HpcClusterProperty cmdlet to change the value of the ReportingDBSize configuration parameter.