BlazeMeter Usage Reports provide metrics about the utilization of BlazeMeter in your organization. These metrics include high-level utilization data that is available either in graphs or JSON payloads, aggregated daily. You can also download detailed (per-test) utilization data in CSV format.
This article covers the following topics:
- How to Access Usage Reports
- How to Filter Usage Reports By Type and Time Period
- How to Download Detailed Usage Reports
- Usage Report Scope and Access Permissions
- Retrieve Usage Report Data with the BlazeMeter API
Access Usage Reports
Follow these steps:
- Click the Cog icon to navigate to the Settings menu in the BlazeMeter UI.
- Select the level, either Account or Workspace.
- Select Usage Reports.
Alternatively you can also automate report gathering by making calls to the BlazeMeter API, as described below.
Filter Usage Reports By Type and Time Period
BlazeMeter aggregates usage report on a daily basis. These aggregated reports provide quick, high-level usage information. Usage reports display information based on the type of plan they have.
You can filter the usage reports by the following criteria:
- Start Date
- End Date
- Group by
In certain reports, the totals can be grouped by either test type or user.
- Test Type (only for Number of Tests, Variable Unit Hours, and Max Number of Variable Units)
- User (only for Variable Unit Hours)
- None (default)
- Select Report Type
- Number of Tests
- API Functional Tests - Number of API Calls
- Number of Server Hours
- Variable Unit Hours
- Max Number of Variable Units
Note: This report type does not yet include Mock Services and API Monitoring capabilities.
- Mock Services Transactions
- Mock Services Concurrent Usage
- GUI Functional Tests - Number of Browser sessions
On the far right, the usage report also indicates the total - either the total number of tests, of calls, of hours, of transactions, or of users, respectively,
For more specific information about Mock Services Transactions and Mock Services Concurrent Usage metrics, see Mock Services Analytics.
How to Download Detailed Usage Reports
If you need more details about test names, project-level utilization, test size and duration, and much more, download the Detailed Usage Report CSV file.
In the detailed report you will find the following information:
| Item | Description |
|---|---|
|
Date |
Displays Date and time the test ran. |
|
Workspace Id |
Displays a Unique identifier of the workspace in an account |
|
Workspace Name |
Displays name of the workspace. |
|
Test Name |
Displays name of the test configuration. |
|
Link to Test |
Identifies the URL to your test in the workspace. Requires workspace permissions to view. |
|
Report Name |
Displays name of the report for the test run. Defaults to Test Name but can be edited to reflect build number or other useful information. |
|
Link to Report |
Displays URL for viewing the report in the workspace. Requires workspace permissions to view. |
|
Max Users |
Displays the max number of virtual users reached during the test. |
|
Duration (m) |
Displays the duration of the test run. A test stopped prior to configured duration will show actual run time. |
|
Number of Virtual Users |
Displays number of configured virtual users. |
|
Number Of Servers |
Displays the number of provisioned engines or instances in a test. |
|
Server Hours |
Displays the number of server hours consumed by provisioned engines or instances in a test. |
|
Variable Unit Hours |
Displays the number of Variable Unit Hours consumed in a test. |
|
Functional Test API calls |
Applies only to Functional API tests: The number of calls made in your test scenario. |
|
Locations |
Indicates the geolocation of the load generators. For more information about locations, see Load Distribution. |
|
Test Type |
Displays as: JMeter, Taurus, FunctionalGui, FunctionalAPI, or URL. |
|
Execution Client Id |
Describes type of client that launched the test. Examples: GUI, API, Taurus, BE_CHROME (Chrome Extension), etc. |
|
Is Free Test |
Confirms whether credits were consumed. |
|
Credits Type |
Identifies the credit option for a test. |
|
Credits Used |
Identifies the number of consumed credits for a test. |
|
Plan Name |
Indicates the assigned name of the provisioned plan to your account. |
|
Project Id |
Displays a Unique identifier of the project in a workspace. |
|
Project Name |
Displays the assigned name of project. |
|
User Id |
Displays a Unique identifier of User. |
|
User Email |
Displays the email from User in the account or workspace. |
|
First Name |
Displays the first name of the user. |
|
Last Name |
Displays the last name of user. |
|
Report Notes |
Allows user to enter notes and comments about the results. |
|
First Sample |
Displays Date and time of first sent sample. |
|
Last Sample |
Displays Date and time of last sent sample. |
|
Parallel tests in account |
Indicates the number of tests running concurrently in the entire account. |
|
Parallel tests in workspace |
Indicates the number of tests running concurrently in the workspace this test belongs to. |
|
End user experience test used |
Indicates the number of end-user experience monitoring test credits consumed. |
Usage Report Scope and Access Permissions
Account Level Usage Report
Account-level Usage Reports cover usage from all workspaces. They can be accessed by users with the following roles:
- Owner
- Admin
- Billing
To access the Account-level Usage Report, click the Cog icon at the top right of the application and choose Settings > Account > Usage Report.
Workspace Level Usage Report
Workspace-level Usage Reports cover only a single workspace. They can be accessed by any of the above Account-level roles, as well as the following Workspace-level role.
- (Workspace) Manager
To access the Workspace level Usage Report, click the Cog icon at the top right of the application and choose Settings > Workspace > Usage Report.
You can check membership under Settings > Workspaces > Members.
Retrieve Usage Report Data with the BlazeMeter API
Using API calls is useful if you want to automate downloading reports. For more information on how to handle the required authentication of your API calls, see Authorization.
To fetch aggregate usage report data in JSON, or detailed Usage Report in CSV format through our API, make calls modeled after the following examples.
Aggregated Usage Data in JSON Format:
- Example API call to pull aggregated data in JSON format at an Account level
https://a.blazemeter.com/api/v4/accounts/84084/reports/usage/tests/credits?daysInterval=1&toDate=1537253999&fromDate=1534489200
- Example API Call to pull aggregated data in JSON format at a Workspace level
https://a.blazemeter.com/api/v4/workspaces/75969/reports/usage/tests/credits?daysInterval=1&toDate=1537253999&fromDate=1534489200
Detailed Usage Data in CSV Format:
- Example API call to pull a detailed CSV at an Account level
https://a.blazemeter.com/api/v4/accounts/84084/reports/usage/tests/credits?daysInterval=1&toDate=1537253999&fromDate=1534489200&download=true
- Example API Call to pull a detailed CSV at a Workspace level
https://a.blazemeter.com/api/v4/workspaces/75969/reports/usage/tests/credits?daysInterval=1&toDate=1537253999&fromDate=1534489200&download=true
0 Comments