---
title: "Global Settings: Usage Monitor"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/74352876/Global%20Settings%3A%20Usage%20Monitor"
format: markdown
---
![image](media://a2a48ad2-8aea-4229-809a-02e9c48e339f)

> Macro (ui-expand)
> 
> > Macro (toc)

# Introduction

The **Xray Usage Monitor** is a reporting tool that helps 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.

# <span style="color: #172b4d">Access</span>

> ℹ️ Xray Usage Monitor is only available for Administrators using [Xray Enterprise and Xray Advanced](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/392921546).
> ℹ️ 
> ℹ️ This tool shows only the top five results due to performance considerations.

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)

# <span style="color: #172b4d">Operations</span>

## <span style="color: #172b4d">Generating a Usage Monitor Report</span>

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to the Usage Monitor screen (Figure 2).
> 
> > Macro (rw-step)
> 
> Click the *Check Now* button (Figure 2 - 1).
> 
> > Macro (rw-step)
> 
> The system will initiate a generation of a Usage Monitor report and a progress bar will appear (Figure 3 - 1).
> 
> ![Figure 3 - Progress](media://37d86508-1aef-4b6a-941f-15c0e03792e5)
> 
> > Macro (rw-step)
> 
> When finished, you will see a success message (Figure 4 - 1). Click the *Acknowledge*** **button (Figure 4 - 2).
> 
> ![Figure 4 - Success](media://9a4dd9f8-4098-4103-b931-1664af8db163)
> 
> > Macro (rw-step)
> 
> The report will appear (Figure 5). You can click *Export* (Figure 5 - 1) to export the document into a CSV file. More below.
> 
> ![Figure 5 - Report](media://7190138d-13bb-4a7f-8439-6bec02459ca0)
> 
> > ℹ️ A new Usage Monitor report can only be generated after 24 hours.


## Cancelling the Report Generation

You can cancel the creation of a new report while it's being generated.

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)
> 
> > ℹ️ <span style="color: #172b4d">In this case, the data from the previous report continues to be displayed (if it exists).</span>

# <span style="color: #172b4d">Usage Monitor Screen</span>

<span style="color: #172b4d">The Usage Montiro screen is presented in two tabs:</span>

- <span style="color: #172b4d">Overview.</span>
- <span style="color: #172b4d">Projects.</span>

## <span style="color: #172b4d">Overview Tab</span>

<span style="color: #172b4d">This view (Figure 7 - 1) provides a high-level summary of performance across the instance.</span>

![Figure 7 - Overview](media://79ac4fc2-afe1-4282-96b7-7240848ece5b)

### Overview Sections

- Entities (Figure 7 - 2)
  - <span style="color: #172b4d">Xray Issue Type-Based Entities (sub-section of Entities).</span>
- <span style="color: #172b4d">Projects.</span>
- <span style="color: #172b4d">Tests.</span>
- <span style="color: #172b4d">[Preconditions](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565159)</span><span style="color: #172b4d">.</span>
- <span style="color: #172b4d">[Test Sets](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565163)</span><span style="color: #172b4d">.</span>
- <span style="color: #172b4d">[Test Executions](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565117)</span><span style="color: #172b4d">.</span>
- <span style="color: #172b4d">[Test Plans](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565153)</span><span style="color: #172b4d">.</span>
- <span style="color: #172b4d">Requirements.</span>
- <span style="color: #172b4d">Anti-Pattern Metrics.</span>

#### <span style="color: #172b4d">Metrics Available in Each Section</span>  


| Entities | Description |
| --- | --- |
| <span style="color: #172b4d">Custom Test Statuses</span> | Number of existing Custom Test Statuses in [Xray Global settings](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565853) |
| <span style="color: #172b4d">Custom Test Step Statuses</span> | Number of existing Custom Test Step Statuses in Xray Global settings |
| <span style="color: #172b4d">Test Environments</span> | Number of existing Test Environments |
| <span style="color: #172b4d">Test Types</span> | Number of existing Test Types. |
| <span style="color: #172b4d">Projects with remote jobs</span> | Number of Projects with remote jobs (configuration active) |
| <span style="color: #172b4d">Step Custom Fields</span> | Number of existing Custom [Test Step](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565316) Fields |
| <span style="color: #172b4d">Test Run Custom Fields</span> | Number of the existing [Test Run](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565109) Custom Fields |
| <span style="color: #172b4d">Parameter Value Lists</span> | Number of the Parameters value lists (used in data sets) |
| <span style="color: #172b4d">Projects with Requirement Coverage enabled</span> | Number of Projects with Requirement Coverage Enabled in Project settings |
| <span style="color: #172b4d">Reported Defects</span> | Number of Defects linked to Test Runs |
| <span style="color: #172b4d">Manual Tests</span> | Number of existing Manual Tests |
| <span style="color: #172b4d">Cucumber Tests</span> | Number of existing Cucumber Tests |
| <span style="color: #172b4d">Generic Tests</span> | Number of existing Generic Tests |
| <span style="color: #172b4d">Tests With Versions</span> | Number of existing Tests with multiple versions |

| Xray Issue Type-Based Entities | Description |
| --- | --- |
| Tests | Number of existing Tests |
| <span style="color: #172b4d">Pre-Conditions</span> | Number of existing Preconditions |
| <span style="color: #172b4d">Test Sets</span> | Number of existing <span style="color: #172b4d">Test Sets</span> |
| <span style="color: #172b4d">Test Runs</span> | Number of existing <span style="color: #172b4d">Test Runs</span> |
| <span style="color: #172b4d">Test Executions</span> | Number of existing <span style="color: #172b4d">Test Executions</span> |
| <span style="color: #172b4d">Sub-Test Executions</span> | Number of existing <span style="color: #172b4d">Sub-Test Executions</span> |
| <span style="color: #172b4d">Test Plans</span> | Number of existing <span style="color: #172b4d">Test Plans</span> |
| <span style="color: #172b4d">Dynamic Test Plans</span> | Number of Test Plans where the Tests were added by using the filter |

| Projects | Description |
| --- | --- |
| <span style="color: #172b4d">Projects with more Requirements without Tests</span> | List of the top 5 Projects with more requirements without Tests |
| <span style="color: #172b4d">Projects with more Requirements</span> | List of the top 5 Projects with more Requirements |
| <span style="color: #172b4d">Projects with more Tests</span> | List of the top 5 Projects with more Tests |
| <span style="color: #172b4d">Projects with more Manual Tests</span> | List of the top 5 Projects with more Manual Tests |
| <span style="color: #172b4d">Projects with more Cucumber Tests</span> | List of the top 5 Projects with more Cucumber Tests |
| <span style="color: #172b4d">Projects with more Generic Tests</span> | List of the top 5 Projects with more Generic Tests |
| <span style="color: #172b4d">Projects with more </span><span style="color: #172b4d">[Automated Tests](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565278)</span> | List of the top 5 Projects with more Automated Tests |
| <span style="color: #172b4d">Projects with more Tests Without Test Runs</span> | List of the top 5 Projects with more Tests <span style="color: #172b4d">without Test Runs</span> |
| <span style="color: #172b4d">Projects with more Datasets</span> | List of the top 5 Projects with more Datasets <span style="color: #172b4d">(used at either Test, Test Plan, or Test Run level)</span> |
| <span style="color: #172b4d">Projects with more Dataset iterations</span> | List of the top 5 Projects with more Dataset Iterations |
| <span style="color: #172b4d">Projects with more Test Sets</span> | List of the top 5 Projects with more Test Sets |
| <span style="color: #172b4d">Projects with more Test Runs</span> | List of the top 5 Projects with more Test Runs |
| <span style="color: #172b4d">Projects with more Manual Test Runs</span> | List of the top 5 Projects with more Manual Test Runs |
| <span style="color: #172b4d">Projects with more Cucumber Test Runs</span> | List of the top 5 Projects with more Cucumber Test Runs |
| <span style="color: #172b4d">Projects with more Generic Test Runs</span> | List of the top 5 Projects with more Generic Test Runs |
| <span style="color: #172b4d">Projects with more Test Executions</span> | List of the top 5 Projects with more Test Executions |
| <span style="color: #172b4d">Projects with more Sub Test Executions</span> | List of the top 5 Projects with more Sub Test Executions |
| <span style="color: #172b4d">Projects with more Test Plans</span> | List of the top 5 Projects with more Test Plans |
| <span style="color: #172b4d">Projects with more </span><span style="color: #172b4d">[Test Repository](https://getxraydocs.atlassian.net/wiki/display/XRAYCLOUD/Test+Repository)</span><span style="color: #172b4d"> folders</span> | <span style="color: #172b4d">List of the top 5 Projects with more Test Repository folders</span> |

| Tests | Description |
| --- | --- |
| <span style="color: #172b4d">[Test Case Designer](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565543)</span><span style="color: #172b4d"> Tests</span> | 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 |
| --- | --- |
| <span style="color: #172b4d">Total orphan preconditions</span> | Number of Preconditions not associated/linked to any Issue |
| <span style="color: #172b4d">Preconditions for more Tests</span> | List of the top 5 Preconditions most used in the Tests |

| Test Sets | Description |
| --- | --- |
| <span style="color: #172b4d">Test Sets Without Tests</span> | 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 |
| --- | --- |
| <span style="color: #172b4d">Test Plans without Tests</span> | Number of Test Plans without Tests |
| <span style="color: #172b4d">Test Plans without Test Executions</span> | Number of Test Plans without Test Executions |
| Test Plans with more Tests | List of the top 5 Test Plans with more Tests |
| <span style="color: #172b4d">Test Plans with more Test Executions</span> | List of the top 5 Test Plans with more Test 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 <span style="color: #172b4d">on the Board</span> |

| Requirements | Description |
| --- | --- |
| <span style="color: #172b4d">Total Requirements</span> | Number of existent Requirements |
| <span style="color: #172b4d">Requirements with more Tests</span> | List of the top 5 Requirements with more Tests |
| <span style="color: #172b4d">Requirements with more Test Runs</span> | List of the top 5 Requirements with more Test Runs |

| Anti-Pattern Metrics | Description |
| --- | --- |
| <span style="color: #172b4d">Resolved Requirements Without Tests</span> | List of the top 5 Requirements in "Resolved" status without Tests |
| <span style="color: #172b4d">Manual Tests Without Steps</span> | List of the top 5 Manual Tests without Steps |
| <span style="color: #172b4d">Manual Tests With Too Many Steps</span> | List of the top 5 Manual Tests with too many Steps |
| <span style="color: #172b4d">Tests Without Executions</span> | List of the top 5 Tests without Steps without Executions |
| <span style="color: #172b4d">Test Executions Without Test Runs</span> | List of the top 5 Test Executions without Test Runs |
| <span style="color: #172b4d">Sub-Test Executions as Sub-Tasks</span> | List of Sub-tasks of type "Sub Test Execution" linked to Test Execution Issues |

  


> ℹ️ ### Anti-Pattern Metrics
> ℹ️ 
> ℹ️ 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.

## <span style="color: #172b4d">Projects Tab</span>

<span style="color: #172b4d">This view (Figure 8) dives deeper and provides detailed information about the performance of each of the selected projects.</span>

![Figure 8 - Projects](media://22be668c-e187-45cc-b5b7-4480389292a6)

<span style="color: #172b4d">This screen (Figure 9) allows you to select a maximum of five Projects to check the metrics. </span>

![Figure 9 - Projects](media://c0f4ca2a-fb42-4afa-9106-97d3bb4a6a95)

### Projects Sections

- Entities
  - Xray Issue Type-Based Entities (sub-section of Entities).
- Requirements.

#### Metrics Available in Each Section  


| **Entities** | **Description** |
| --- | --- |
| Reported Defects | <span style="color: #172b4d">Number of Defects linked to Test Runs in the Project</span> |
| Manual Tests | <span style="color: #172b4d">Number of Manual Tests in the Project</span> |
| Cucumber Tests | <span style="color: #172b4d">Number of Cucumber Tests in the Project</span> |
| Generic Tests | <span style="color: #172b4d">Number of Generic Tests in the Project</span> |
| Tests With versions | <span style="color: #172b4d">Number of Tests with Versions in the Project</span> |
| Test Repository folders | <span style="color: #172b4d">Number of folders in the Test Repository (considers the Test Repository root folder)</span> |
| Test Runs by Test Type | List of Test Runs by Test Type in the Project |

| **Xray Issue Type-Based Entities** | **Description** |
| --- | --- |
| Tests | Number of existent Tests in the Project |
| Preconditions | Number of existent Preconditions in the Project |
| Test Sets | Number of existent Test Sets in the Project |
| Test Runs | Number of existent Test Runs in the Project. |
| Test Executions | Number of existent Test Executions in the Project |
| Sub-Test Executions | Number of existent Sub-Test Executions in the Project |
| Test Plans | Number of existent Test Plans in the Project |
| Dynamic Test Plans | Number of existent Dynamic Test Plans in the Project |

| **Requirements** | **Description** |
| --- | --- |
| Total Requirements | Number of Requirements in the Project |
| <span style="color: #172b4d">Total Requirements Without Direct Tests</span> | Number of Requirements without Direct Tests in the Project |
| Requirements With Most Tests | List of the top 5 Requirements with the most Tests in the Project |
| Requirements With Most Test Runs | List of the top 5 Requirements with the most Test Runs in the Project |

## Functionalities

### <span style="color: #172b4d">Index</span>

<span style="color: #172b4d">On the right side of the screen, there is a collapsible/expandable index, called </span><span style="color: #172b4d">*On this page*</span><span style="color: #172b4d"> (Figure 10 - 1), visible in the </span><span style="color: #172b4d">*Overview*</span><span style="color: #172b4d"> and </span><span style="color: #172b4d">*Projects*</span><span style="color: #172b4d"> tabs. This index allows users to navigate quickly throughout the screen by using the hyperlinks listed there. When an element is clicked (Figure 10 - 2), you can scroll until the selected element and focus the respective area (Figure 10 - 3).</span>

![Figure 10 - Index](media://abc988f6-a1a5-4c87-ade8-bea745f08a7a)

### <span style="color: #172b4d">View Settings</span>

<span style="color: #172b4d">When the Projects tab is selected, a </span><span style="color: #172b4d">*View Settings*</span><span style="color: #172b4d"> button appears (Figure 11 - 1). Two options are displayed:</span>

- <span style="color: #172b4d">Expand all items (it expands all the projects listed; Figure 11 - 2).</span>
- <span style="color: #172b4d">Collapse all items (it collapses all the projects listed; Figure 11 - 2).</span>

![Figure 11 - Settings](media://ac049feb-e804-4c4a-8248-c42a3aeeed48)

### Exporting a Report

After generating a Usage Monitor report, it's possible to export the data in a report: a CSV file.

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)

  


<details>
<summary>Support/Troubleshooting</summary>

If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577312).
</details>