hIOmon Benchmarking Add-On Support

		h	IO	mon	™
		The File I/O Performance Monitor

Making data perform^{^SM}

Home | Products & Services | Contact | About hyperI/O^sm

Big Picture		hIOmon Benchmarking Support Add-On
Product Info		The hIOmon "Benchmarking Support Add-On" enables you to quickly and easily utilize the hIOmon software so as to retrieve real-time, user-specified "I/O summary" (i.e., aggregated) operation performance metrics for the files, devices, and processes currently being monitored by the hIOmon I/O Monitor. These metrics can include the "Physical Device Extended Metrics". Moreover, the retrieved metrics can reflect the actual file and device I/O activity generated as a result of running, as examples, a disk and/or file benchmarking tool, a synthetic application workload benchmarking tool, or even applications in everyday usage.
Features
Architecture
Screen Shots
Documentation
Download

The Add-On also allows you to immediately write (export) the retrieved metrics to a Comma-Separated-Values (CSV) disk file. The particular metrics saved to this CSV file are based upon the metric type names that you specify within the header (first) row of the CSV file. This enables you to select only those particular metric types of interest to you (i.e., the CSV file will only include those particular metric types that you specify). You can use this Add-On to retrieve and save the selected I/O operation performance information/metrics at the completion of your benchmark testing and also periodically during the benchmark testing at your convenience. Please see "Benchmarking with hIOmon" for additional information, including the various benchmarking scenarios supported by hIOmon along with the benchmarking advantages, metrics, and interface support provided by hIOmon. The hIOmon "Benchmarking Support Add-On" is included within the standard hIOmon software installation package. The Add-On uses a DOS command batch file together with various hIOmon WMI Support VBScripts: The "hIOmonBenchmarkExport.bat" file is a hIOmon-specific Microsoft® Windows® DOS command batch file. It is basically a convenience script that is used to direct the activation of the specified hIOmon "Filter Selection" as well as the retrieval and saving of the real-time "summary" I/O operation performance metrics (for files, devices, and/or processes) to the specified CSV file. In addition, this batch file can be used in either interactive mode (i.e., prompts displayed for input) or non-interactive mode (i.e., input provided by means of command line parameters). The "hIOmonGetSaveMetrics" VBScript file, which makes use of the hIOmon WMI Support to retrieve the currently-accumulated, summary I/O operation performance metrics that have been collected by the hIOmon I/O Monitor component. These metrics can be for devices, files, and/or processes. Specifically, this script retrieves from the hIOmon Manager the current, real-time accumulated values for those particular metric types identified within the header row of the specified CSV file; the retrieved metrics are then written/exported to the specified CSV file. This script is invoked by the "hIOmonBenchmarkExport" batch file (but can also be invoked directly in either interactive or non-interactive mode). The "hIOmonSetFilters" VBScript file, which is used by the “hIOmonBenchmarkExport” batch file to load/activate the specified hIOmon Filter Selection (a “Filter Selection” is a hIOmon-specific file that is used by the hIOmon software to identify which particular files, devices, and processes are to be monitored by the hIOmon I/O Monitor component along with the particular types of I/O operation performance information/metrics that are to be collected by the hIOmon I/O Monitor). This script can also be invoked directly in either interactive or non-interactive mode.

NOTE:	The hIOmon "Benchmarking Support Add-On" relies upon the "summary" I/O operation performance metrics that can be collected and exported by the hIOmon software. Consequently, the hIOmon "Summarized Data Licensing Option" must be available (licensed for use) in order to make use of this Add-On. In addition, the hIOmon "Raw Device Extended Feature Option" must also be available/licensed if the Add-On is to configure the hIOmon software to collect "Physical Device Extended Metrics".

Overall, the hIOmon "Benchmarking Support Add-On" enables you to quickly and easily gather and save I/O operation performance metrics that you consider germane to your particular benchmark testing. These empirical I/O operation performance metrics (which can reflect the actual use of your very own applications, files, and devices) can then be used to form the basis of your benchmark testing, further validate the results of your benchmarking tools, etc. Additional information is provided below (and also within the "hIOmon Add-On User Guide" document).

Using the Benchmarking Support Add-On

The "hIOmon Benchmarking Support Add-On" VBScripts use the "hIOmon WMI Support" to activate the hIOmon "Filter Selection" and to retrieve the summary I/O operation performance information/metrics that have been collected by the hIOmon I/O Monitor component.

Requirements

The hIOmon "Benchmarking Support Add-On" requires that: The hIOmon File I/O Performance Monitor software be properly installed and active (i.e., that the hIOmon Manager and hIOmon I/O Monitor components are currently running; note that these components are normally configured upon the installation of the hIOmon software to automatically be started when the computer system is started). The "I/O Summary Data" option is licensed. The "Raw Device Extended Feature" option must also be licensed if "Physical Device Extended Metrics" are additionally to be collected by hIOmon. Note that the trial version of the hIOmon File I/O Performance Monitor software includes full-support for both of these licensing options. An existing hIOmon "Filter Selection" be present and available to load/activate. Please note that the "hIOmon Presentation Client", the "hIOmon WMI Browser", or the hIOmon CLI Support can be used to create a Filter Selection; see the "hIOmon User Guide" document for details. In addition, several of the other hIOmon Add-Ons (e.g., the "Device and File I/O Performance Analysis Add-On", the "Process I/O Performance Analysis Add-On", and the "Fragmented File I/O Operation Metrics Analysis Add-On") can be used to create the hIOmon Filter Selection. Also note that all of these hIOmon Add-Ons are included within the standard hIOmon software installation package. A Comma-Separated-Values (CSV) file that contains a header row, which identifies the specific summary metric types to be collected and saved within the CSV file. The names of these summary metric types are the property names (i.e., field names) defined for the "hIOmon_PerfStatsDevice" class (for device metrics), the "hIOmon_PerfStatsFileExtInfo" class (for file metrics), and the "hIOmon_PerfStatsProcess" class (for process metrics) associated with the hIOmon "WMI/CIM MOF" support. These property names can be easily displayed using the "hIOmon WMI Browser" (i.e., select the "Help -> hIOmon CIM/MOF Classes" menu display option, then select either the "hIOmon_PerfStatsDevice", the "hIOmon_PerfStatsFileExtInfo", or the "hIOmon_PerfStatsProcess" class). Each column within the header row must have a separate metric type name (and the name is case-insensitive). Note that the metric type names specified within the header row (i.e., first row) represent the particular summary metric types that are to be collected and written to the CSV file. This header row must be terminated by a "newline" character. Also note that the metric values saved to the CSV file are the real-time accumulated metric values that have been collected by the hIOmon I/O Monitor and that are currently available for retrieval by the hIOmon Manager. Note that if the specified CSV file does not exist, then a CSV file with the specified name will automatically be created by the "hIOmonGetSaveMetrics" VBScript; this CSV file will contain a header row that consists of a default set of summary I/O operation performance metrics. A limited set of input parameters (e.g., the name of the Filter Selection to be activated, the name of the CSV file to which the retrieved I/O operation performance metrics are to be written, etc.). These input parameters can be specified either interactively (i.e., through displayed input prompts) or non-interactively (i.e., provided by means of command line parameters).

Where to find the Add-On script files

Unlike the other hIOmon Add-Ons, the "hIOmonBenchmarkExport" batch file is located within the "..\hIOmon\Support\hIOmonWMI\Scripting\Wsh\VBScript" directory where the various hIOmon WMI VBScripts (including "hIOmonGetSaveMetrics" and "hIOmonSetFilters") were installed as part of the standard hIOmon software installation process. Note that the "hIOmonBenchmarkExport" batch file must be used within the same directory where the "hIOmonGetSaveMetrics" and "hIOmonSetFilters" VBScripts noted above reside.

How to run the Add-On

The hIOmon "Benchmarking Support Add-On" uses the "hIOmonBenchmarkingExport" batch file to direct whether a specified Filter Selection is to be activated or instead the selected I/O operation performance metrics are to be written to the specified CSV file. Accordingly, this batch file provides two separate primary options (only one of which can be requested when the batch file is invoked): When invoked with the "START" option, the batch file activates the specified hIOmon Filter Selection; this activation will also cause the summary I/O operation performance metric counters within the hIOmon I/O Monitor to be re-initialized (reset to zeroes). This option requires that the name of the Filter Selection also be specified. When invoked with the "SAVE" option, the batch file causes: The retrieval of the specified summary I/O operation performance metrics from the hIOmon Manager; these metrics reflect the real-time accumulated values as currently collected/maintained within the hIOmon I/O Monitor. The "Save" option also requires that you specify whether the summary I/O operation performance metrics are retrieved/written for all devices, all files, and/or all processes for which the hIOmon I/O Monitor has metrics available. The retrieved metrics to be written to the CSV file whose name must also be specified. Back to Top

Invoking the Batch File

The "hIOmonBenchmarkingExport" Windows DOS command batch file can be invoked either interactively or non-interactively: To run this batch file interactively (i.e., in which case you will be prompted for the required information and options), simply run the batch file with the "interactive" option (which is the letter "i"): hIOmonBenchmarkExport i To run this batch file without prompts requesting input parameters, you can specify the required parameters themselves (note that options are positional): hIOmonBenchmarkExport start filterSelectionName hIOmonBenchmarkExport save csvFileName d \| f \| p "start" (or "save"). Specify either "start" (which indicates that the tasks previously described above for the "Start" option are to be performed) or "save" (which indicates that the tasks described above for the "Save" option are to be performed). "filterSelectionName". Specify the name of the Filter Selection that is to be loaded/activated; note that this parameter only applies to and is required by the "Start" option. "csvFileName". Specify the name of the CSV file to which the metrics are to be saved. Note that only the filename and not the file extension type (i.e., ".csv") is specified; for example, specify simply "test" for the CSV file called "test.csv" (i.e., the ".csv" is assumed). If the specified CSV file does not exist, then a CSV file with the specified name will automatically be created with a header row that consists of a default set of summary I/O operation performance metrics. Also note the header (first) row requirements described above (q.v., "Requirements"). In addition, note that this parameter and the following "d", "f", and "p" parameters (in any combination) only apply to and are required by the "Save" option: "d" - The letter "d" indicates that the specified metrics are to be retrieved and saved for all devices for which the hIOmon I/O Monitor currently has summary I/O operation metrics available for retrieval by the hIOmon Manager. "f" - The letter "f" indicates that the specified metrics are to be retrieved and saved for all files for which the hIOmon I/O Monitor currently has summary I/O operation metrics available for retrieval by the hIOmon Manager. "p" - The letter "p" indicates that the specified metrics are to be retrieved and saved for all processes for which the hIOmon I/O Monitor currently has summary I/O operation metrics available for retrieval by the hIOmon Manager. Note that the "Save" option can be invoked repeatedly throughout the benchmark testing. The current accumulated values of the selected I/O operation performance metrics will be retrieved from the hIOmon I/O Monitor and then written to the specified CSV file each time the batch file is invoked with the "Save" option. Also note that you can directly invoke (in either interactive or non-interactive mode) the "hIOmonGetSaveMetrics" VBScript to retrieve/save the current metric values. For additional information, please see the "Benchmarking Support Add-On" chapter within the "hIOmon Add-On User Guide" document. Back to Top

Usage Example

The hIOmon "Benchmarking Support Add-On" makes it easy and quick to gather, as part of your benchmarking activities, the many file and device I/O operation performance metrics uniquely collected by hIOmon.

As an example, you can:

Run the "hIOmonBenchmarkExport" batch file as "hIOmonBenchmarkExport i" (which would cause the hIOmon Add-On scripts to run interactively).
Respond to the input prompt ("Start or Save?") by entering "Start", which will result in another prompt asking you for the name of the Filter Selection to be started/activated; respond to this prompt by entering the name of the Filter Selection to be started/activated.

Begin your benchmarking test(s).

At the end of your benchmarking test(s), run the "hIOmonBenchmarkExport" batch file again as "hIOmonBenchmarkExport i".

Respond to the input prompt ("Start or Save?") by entering "Save". This will cause the "hIOmonGetSaveMetrics" VBScript file to be automatically invoked in interactive mode, which in turn will result in the following four prompts for input:

Enter the name of the CSV file to which you want the retrieved metrics to be written (note the CSV file requirements mentioned above).
Enter whether you want the metrics to be retrieved and saved for all devices for which the hIOmon Monitor currently has real-time summary I/O operation performance metrics available for retrieval.
Enter whether you want the metrics to be retrieved and saved for all files for which the hIOmon Monitor currently has real-time summary I/O operation performance metrics available for retrieval.
Enter whether you want the metrics to be retrieved and saved for all processes for which the hIOmon Monitor currently has real-time summary I/O operation performance metrics available for retrieval.

That’s it! Please note that you can also run the "hIOmonBenchmarkExport" batch file periodically during your benchmarking test(s) to retrieve and save the current accumulated I/O operation performance metrics collected by hIOmon.

Also please note that you can also run the "hIOmonBenchmarkExport" batch file in non-interactive mode (so that you can, for example, incorporate it within your scripts used to perform your benchmark testing).

hyperI/O^{^sm} - improving the performance of storage I/O in computer servers

All trademarks mentioned herein are the property of their respective owners.