The Xray Usage Monitor is a reporting tool developed for Xray Enterprise users to help administrators manage their Jira projects. It allows administrators to quickly analyze data on app usage and identify areas for improvement. By consulting the generated Usage Monitor report, they can apply best practices to optimize their projects.
Xray Usage Monitor is only available for Administrators using Xray Enterprise. This tool shows only the top 5 results due to performance considerations. |
|
|
You can cancel the creation of a new report while it's being generated.
|
The Usage Monitor screen is presented in two tabs:
This view (Figure 5 - 1) provides a high-level summary of performance across the instance.
Figure 5 - Overview
| Entities | Description |
|---|---|
| Custom Test Statuses | Number of the existing Custom Test Statuses in Xray Global settings |
Custom Test Step Statuses | Number of the existing Custom Test Step Statuses in Xray Global settings |
| Test Environments | Number of the existing Test Environments |
| Test Types | Number of the existing Test Types. |
| Projects with remote jobs | Number of Projects with remote jobs (configuration active) |
| Step Custom Fields | Number of the existing Custom Test Step Fields |
| Test Run Custom Fields | Number of the existing Test Run Custom Fields |
| Parameter Value Lists | Number of the Parameters value lists (used in data sets) |
| Projects with Requirement Coverage enabled | Number of the Projects with Requirement Coverage Enabled in Project settings |
| Reported Defects | Number of the Defects linked to Test Runs |
| Manual Tests | Number of the existing Manual Tests |
| Cucumber Tests | Number of the existing Cucumber Tests |
| Generic Tests | Number of the existing Generic Tests |
| Tests With Versions | Number of the existing Tests with multiple versions |
Xray Issue Type-Based Entities | Description |
|---|---|
| Tests | Number of the existing Tests |
| Pre-Conditions | Number of the existing Preconditions |
| Test Sets | Number of the existing Test Sets |
| Test Runs | Number of the existing Test Runs |
| Test Executions | Number of the existing Test Executions |
| Sub-Test Executions | Number of the existing Sub-Test Executions |
| Test Plans | Number of the existing Test Plans |
| Dynamic Test Plans | Number of the Test Plans where the Tests were added by using the filter |
| Projects | Description |
|---|---|
| Projects with more Requirements without Tests | List of the top 5 Projects with more requirements without Tests |
| Projects with more Requirements | List of the top 5 Projects with more Requirements |
| Projects with more Tests | List of the top 5 Projects with more Tests |
| Projects with more Manual Tests | List of the top 5 Projects with more Manual Tests |
| Projects with more Cucumber Tests | List of the top 5 Projects with more Cucumber Tests |
| Projects with more Generic Tests | List of the top 5 Projects with more Generic Tests |
| Projects with more Automated Tests | List of the top 5 Projects with more Automated Tests |
| Projects with more Tests Without Test Runs | List of the top 5 Projects with more Tests without Test Runs |
| Projects with more Datasets | List of the top 5 Projects with more Datasets (used at either Test, Test Plan, or Test Run level) |
| Projects with more Dataset iterations | List of the top 5 Projects with more Dataset Iterations |
| Projects with more Test Sets | List of the top 5 Projects with more Test Sets |
| Projects with more Test Runs | List of the top 5 Projects with more Test Runs |
| Projects with more Manual Test Runs | List of the top 5 Projects with more Manual Test Runs |
| Projects with more Cucumber Test Runs | List of the top 5 Projects with more Cucumber Test Runs |
| Projects with more Generic Test Runs | List of the top 5 Projects with more Generic Test Runs |
| Projects with more Test Executions | List of the top 5 Projects with more Test Executions |
| Projects with more Sub Test Executions | List of the top 5 Projects with more Sub Test Executions |
| Projects with more Test Plans | List of the top 5 Projects with more Test Plans |
| Projects with more Test Repository folders | List of the top 5 Projects with more Test Repository folders |
| Tests | Description |
|---|---|
| Test Case Designer Tests | Number of Tests created using the Test Case Designer |
Manual Tests with more Test Steps | List of the top 5 Tests with more Test Steps |
Tests in Most Test Sets | List of the top 5 Tests in most Test Sets |
Tests in Most Test Plans | List of the top 5 Tests in most Test Plans |
Tests in Most Test Executions | List of the top 5 Tests in Test Executions |
Tests with most versions | List of the top 5 Tests with the most Versions created (default version is considered) |
| Preconditions | Description |
|---|---|
| Total orphan preconditions | Number of Preconditions not associated/linked to any Issue |
| Preconditions for more Tests | List of the top 5 Preconditions more used in the Tests |
| Test Sets | Description |
|---|---|
| Test Sets Without Tests | Number of Test Sets without Tests |
Test Sets With Most Tests | List of the top 5 Test Sets with Tests |
| Test Executions | Description |
|---|---|
Test Executions with more Tests | List of the top 5 Test Executions with more Tests |
| Test Plans | Description |
|---|---|
| Test Plans without Tests | Number of Test Plans without Tests |
| Test Plans without Test Executions | Number of Test Plans without Tests Executions |
Test Plans with more Tests | List of the top 5 Test Plans with more Tests |
| Test Plans with more Test Executions | List of the top 5 Test Plans with more Tests Executions |
Test Plans With Most Test Runs | List of the top 5 Test Plans with more Test Runs |
Total Test Plan folders | List of the top 5 Test Plans with more folders on the Board |
| Requirements | Description |
|---|---|
| Total Requirements | Number of the existent Requirements |
| Requirements with more Tests | List of the top 5 Requirements with more Tests |
| Requirements with more Test Runs | List of the top 5 Requirements with more Test Runs |
| Anti-Pattern Metrics | Description |
|---|---|
| Resolved Requirements Without Tests | List of the top 5 Requirements in "Resolved" status without Tests |
| Manual Tests Without Steps | List of the top 5 Manual Tests without Steps |
| Manual Tests With Too Many Steps | List of the top 5 Manual Tests with too many Steps |
| Tests Without Executions | List of the top 5 Tests without Steps without Executions |
| Test Executions Without Test Runs | List of the top 5 Test Executions without Test Runs |
| Sub-Test Executions as Sub-Tasks | List of Sub-tasks of type "Sub Test Execution" linked to Test Execution issues. |
Some anti-pattern metrics are calculated based on the creation date of the issues. All metrics, except for "Resolved Requirements Without Tests" and "Sub-Test Executions as Sub-Tasks," are only calculated for issues created at least seven days prior to the report generation date. |
This view (Figure 6) dives deeper and provides detailed information about the performance of each of the selected projects.
Figure 6 - Projects
This screen (Figure 7) allows you to select a maximum of five Projects to check the metrics.
Figure 7 - Projects
| Entities | Description |
|---|---|
Reported Defects | Number of Defects linked to Test Runs in the Project |
Manual Tests | Number of Manual Tests in the Project |
Cucumber Tests | Number of Cucumber Tests in the Project |
Generic Tests | Number of Generic Tests in the Project |
Tests With versions | Number of Tests with Versions in the Project |
Test Repository folders | Number of folders in the Test Repository (considers the Test Repository root folder) |
Test Runs by Test Type | List of Test Runs by Test Type in the Project |
Xray Issue Type-Based Entities | Description |
|---|---|
Tests | Number of the existent Tests in the Project |
Preconditions | Number of the existent Preconditions in the Project |
Test Sets | Number of the existent Test Sets in the Project |
Test Runs | Number of the existent Test Runs in the Project. |
Test Executions | Number of the existent Test Executions in the Project |
Sub-Test Executions | Number of the existent Sub-Test Executions in the Project |
Test Plans | Number of the existent Test Plans in the Project |
Dynamic Test Plans | Number of the existent Dynamic Test Plans in the Project |
| Requirements | Note |
|---|---|
Total Requirements | Nº of the Requirements in the Project |
| Total Requirements Without Direct Tests | Nº of the Requirements without Direct Tests in the Project |
Requirements With Most Tests | List of the top 5 Requirements with most Tests in the Project |
Requirements With Most Test Runs | List of the top 5 Requirements with most Test Runs in the Project |
On the right side of the screen, there is a collapsible/expandable index, called On this page (Figure 8 - 1), visible in the Overview and Projects tabs. This index allows users to navigate quickly throughout the screen by using the hyperlinks listed there. When an element is clicked (Figure 8 - 2), you can scroll until the selected element and focus the respective area (Figure 8 - 3).
Figure 8 - Index
When the Projects tab is selected, a View Settings button appears (Figure 9 - 1). Two options are displayed:
Figure 9 - Settings
After generating a Usage Monitor report it's possible export the data in a report, a CSV file.
|
If you have questions or technical issues, please contact the Support team via the Customer Portal (Jira service management) or send us a message using the in-app chat. |
