Usage Report
The Flywheel Usage Report provides a way for Site Admin users to inspect the utilization of the Flywheel Site and per project, over a given time range. The report data is intended to help customers understand how each project's utilization is contributing to consumption driven costs.
Tip
All Usage Report results reflect only the project data under management. Storage data does not represent storage used by backups, snapshots, etc. Similarly, files from Smart Copy, Flywheel Exchange Import, or ref-in-place style imports are included in the usage data, despite that storage not contributing to additional physical storage consumption.
Legacy Usage Report (Web UI)
The Usage Report available in the Flywheel Web UI utilizes a "Legacy" reporting API, having the limitation that only data that is accessible at the time the report is run is represented in the report results. Also, the specified date range includes/excludes data based upon when the data was uploaded to Flywheel, or when the gear job was created.
For example: If within the reported date range 500 sessions and 10TB were added, but 100 of those sessions and 2 TB of that data were deleted, the report would only represent the 400 sessions and 8 TB of data that still remained.
Info
The Legacy Usage Report API is deprecated, with limited support. Fixes and new features are only intended to be provided for the newer Daily/Monthly Usage report APIs (described later in this article). The Web UI will soon be migrated to use the updated and supported Usage Reporting APIs. This migration is anticipated with the Flywheel 20.2.0 release.
Generating a Usage Report
To generate a Usage Report, navigate to the Usage Report page, located under the Admin section of the Flywheel sidebar on the left side of the page. A report for the last 6 months will automatically run when the page is first opened.
Tip
To generate a Project Report that represents all data currently in the Project, utilize the "All Time" date range.
Customizing the Report
A custom report can be run by specifying other time ranges, and whether the report data should be grouped by project or by month.
Usage Report (Daily/Monthly APIs)
A set of newer and actively supported usage reporting API are available via the Flywheel Python SDK. This supports querying usage data by month or day, as well as by group or project. This report reflects the total Project data for each day, rather than only reflecting "net new" data. Every night an automated background process collects and preserves usage data to support the largest Flywheel sites, and more use cases.
For example: If 1 TB of data was added to Project A, then on different days moved to Project B, then deleted, that rise and fall of 1 TB of data in both projects would be possible to see in this report. That is not possible with the "net new" data representation in the Legacy Usage Report.
This also makes possible the viewing of historical usage data for now deleted projects.
Soft-Deleted Stats in SDK Usage Report
The 19.4.0 release of Flywheel added Soft Deleted data stats to this usage report.
- Soft Deleted files are those that have been deleted by a user/device, are no longer available via Flywheel user interfaces and APIs, but the file contents still exist, making recovery possible.
- Customers can use the new soft deleted stats to understand how much deleted data may still be consuming infrastructure storage capacity.
- The soft deleted
- Flywheel SDK 19.4.0 or later is required to access the soft deleted stats.
- It may take up to a week after your Flywheel site is upgraded to 19.4.0 for the system to complete the collection of the historical stats to be computed.
Note
The 19.4.0 release of Flywheel added Soft Deleted data stats to this usage report.
SDK Documentation
Flywheel Python SDK documentation is available for both the daily and monthly versions of this report.
Comparing Capabilities
| Report Capability | Legacy | Daily/Monthly |
|---|---|---|
| Net new sessions and storage over time range? | yes | yes |
| Data available for usage from the current day? | yes | no |
| Data available for usage from yesterday and prior days? | yes | yes |
| Includes the project's parent group? | no | yes |
| Total Sessions per project for a given day? | no | yes |
| Usage data attributed to the parent project for the reported day? | no | yes |
| "Soft Deleted" data? | no | yes |
| Separation of usage by Center vs. Lab for Multi Provider customers? | no | yes |
| Supports sites with millions of files and thousands of projects? | no | yes |