The “hIOmon REST API” software package provides a “Representational State Transfer (REST) Application Programming Interface (API)” with a web service component.
It can retrieve information about the hIOmon software (e.g., the current hIOmon Manager status, the status of the active hIOmon ETW I/O Monitor, and usage information for both the hIOmon Manager and hIOmon ETW I/O Monitor). It can also to be used to perform limited control over the operation of the hIOmon I/O operation monitoring software.
In addition, it can retrieve a robust set of I/O operation performance metrics that have been collected and automatically-summarized by the hIOmon ETW I/O Monitor software. These metrics include those displayed by the hIOmon Disk I/O Ranger Display.
The hIOmon REST API software components can be used together with either the hIOmon "Workload I/O Profiler (WIOP)" or the hIOmon "Workload I/O Profiler for Files (WIOPF)" software packages.
The hIOmon REST API software installation package includes and features the following: • The hIOmon REST API Web Service, which runs as a Windows service. This service obtains the requested hIOmon information and automatically-summarized I/O operation performance metrics from the associated hIOmon Manager, which is active upon the same computer upon which the hIOmon REST API Web Service is installed. • The hIOmon REST API interface enables the retrieval of the unique hIOmon “Performance Threshold Range Metrics” and the hIOmon “Data Transfer Size (DTS) Metrics”, which have been collected and automatically-summarized by hIOmon upon an individual device, file, and/or process basis. Moreover, the retrieval can be based upon a user-specified sorted order with over 70 different sort order options available. • Supports the retrieval of real-time summary I/O operation performance metrics • Also supports the retrieval of historical summary I/O operation performance metrics that have been exported/saved to CSV or TSV formatted hIOmon Manager Export Files • Supports coalescing hIOmon Manager Export Files, with an extensive variety of coalesce options (e.g., coalescing upon a daily, weekly, monthly, quarterly, or yearly basis) • The summary I/O operation performance metrics can be retrieved within a JSON format • Supports the hIOmon Disk I/O Ranger Display (Workstation/Server versions only), which displays the hIOmon “Performance Threshold Range and DTS Metrics” within a user-configurable “Bar Chart” format as well as a graphical format. Both real-time and historical summary I/O operation performance metrics (i.e., from hIOmon Manager Export Files) can be retrieved and displayed by the hIOmon Disk I/O Ranger Display. The hIOmon REST API web service supports the hIOmon Disk I/O Ranger Display application, which runs as a Microsoft Windows HTML Application (HTA) and is included within the hIOmon WIOP and hIOmon WIOPF software packages. It also supports the “On-The-Web (OTW)” version of the hIOmon Disk I/O Ranger Display that is included within the hIOmon REST API software package. The OTW version is “online/Internet based”; it effectively enables you to connect to the hIOmon REST API web service in a secure fashion and use the hIOmon Disk I/O Ranger Display software within a supported Web Browser. • Supports the configuration of various hIOmon software components (e.g., hIOmon Filter Selections, hIOmon Manager Export Files, and the hIOmon Manager operation along with hIOmon ETW I/O Monitor operation) • Supports the submission of hIOmon summary I/O operation performance metrics to a Microsoft Azure Log Analytics Workspace upon a periodic basis • Utilizes the latest Microsoft ASP.NET CORE high-performance framework for building modern, cloud-based, Internet-connected applications • Supports a HTTPS/SSL option that enables the secure, encrypted transfer of data between the hIOmon REST API Web Service and the client (e.g., web browser) • JSON Web Token (JWT) support for generating and using JWT authorization tokens (including hIOmon Disk I/O Ranger Display support for using JWT tokens) • Incorporates support for Swagger and the Swagger UI (SwashBuckle User Interface). Swagger can generate a “swagger.json” file that provides machine and human readable documentation for the hIOmon REST API. In addition, the included SwashBuckle UI provides an interactive GUI for describing and executing the hIOmon REST API. |
The hIOmon REST API software package is easy and quick to install. It installs within minutes using the standard Windows Installer.
Moreover, no application, operating system, file, file system, or device changes are required.
NOTE: The hIOmon REST API software packages, which are made available by electronic download only, are offered as a service upon a 30-day subscription fee usage basis at the prices shown. The subscription period starts upon the date when the hIOmon REST API software package is installed, which must be within the month of purchase. Extended-use licenses for additional days can also be purchased separately.
Also note that a registered account is required to make purchases.
hIOmon REST API version for 64-bit operating systems only.
Please note that the price shown below is the service subscription-fee for the initial 30-day usage.
The subscription period starts upon the date that the hIOmon REST API software was installed.
Subscription extension for the hIOmon REST API version.
Note that the first extension period includes the initial 30 days from the date that the hIOmon software was installed. That is, the initial 6 months extension reflects an additional 5 months of usage from the end of the first month when the hIOmon software was installed (for an overall total of 6 months of usage beginning from when the hIOmon software was installed).
A subsequent Subscription Extension extends the subscription from the end of the prior subscription extension.
Also note that the "ending date" of a subscription extension reflects the date upon which the extended subscription will terminate (and so the date upon which the hIOmon REST API software will no longer run).
Subscription extension for the hIOmon REST API version.
Note that the first extension period includes the initial 30 days from the date that the hIOmon software was installed. That is, the initial 12 months extension reflects an additional 11 months of usage from the end of the first month when the hIOmon software was installed (for an overall total of 12 months of usage beginning from when the hIOmon software was installed).
A subsequent Subscription Extension extends the subscription from the end of the prior subscription extension.
Also note that the "ending date" of a subscription extension reflects the date upon which the extended subscription will terminate (and so the date upon which the hIOmon REST API software will no longer run).