Using QRebel

QRebel functions as a standalone web page. The QRebel agents upload data to the secure backend. The data is then analyzed and detailed reports are made available via the QRebel Dashboard.

Tip

We recommend reading the QRebel Quick Start to quickly set up your first project and application.


Dashboard

Dashboard provides the bird’s eye view of the current project. It also provides shortcuts to general QRebel views.

../_images/xrhub_dashboard.png

From top left, the dashboard allows access to the following features:

  • Project select – open the drop-down menu with the current project name to select any other. Bear in mind that additional project names will appear only when you have been invited into other projects.
  • Dashboard – press this button to return to the dashboard home page at any time.
  • Settings – press to open general QRebel settings.
  • Users – press to open the user management view for the current project.
  • Create new application – press this button to create a new app in the current project. Please follow the on-screen instructions to set up the app as needed.

In the top right corner you can:

  • Generic agent – press to open generic agent download page. You’ll be able to find specific configuration options for all your projects and their apps.
  • Send feedback – press this button to send feedback, feature requests or possible issues you might run into with QRebel.

The body area of the dashboard displays any applications that have been configured for the current project.


Application

The application view displays performance problem reports for the latest available build. The reports are generated based on a comparison of the application data across the two most recent available builds. When only one build is available for analysis the dashboard will give you the possibility to view all tracked endpoints for the build. This way you can verify which endpoints are being tested and you know exactly where QRebel will start detecting regressions.

../_images/xrhub_application.png

The following features are available for every application:

  • Application timeline – displays the timeline for all builds recorded for the application. Hovering over timeline entries shows tooltips for the builds.
  • Comparison select tool – this feature can be accessed in the top right corner of the application pane, allowing the user to pick any desired comparison between available builds. By default, QRebel displays a comparison between the two most recent available builds.
  • Issue reports – pressing the report sections will expand them to display more data. Total amount of issues detected for the current comparison are displayed next to the report title.
    • Slow Requests – displays the requests with the greatest performance impact in the current comparison. Hovering over the profile graph for any request will show a more in-depth performance graph. Pressing any slow request entry will display a drill-down trace diff view.
    • Excessive IO – displays entry points with the most excessive input-output issues.
    • Exceptions – displays any exceptions that occurred in the application in the compared builds.

Application settings

Pressing the gear icon next to the application name will display application settings.

../_images/xrhub_application_settings.png

The following settings can be set for every separate application:

  • Application name
    • You’ll see the current name of the app. This field can be used to rename the app.
  • Relative threshold:
    • Increase (default 1.4) – define the relative multiplier threshold at which an entry point will be reported as an issue by QRebel.
    • Scope (default 10%) – define the relative scope threshold at which an entry point will be reported as an issue by QRebel.
  • Absolute threshold:
    • Latency (default 200 ms) – define the absolute latency threshold at which an entry point will be reported as an issue by QRebel.
    • IO count (default 20) – define the absolute IO count threshold at which an entry point will be reported as an issue by QRebel.

Agent Download: the QRebel agent for the specific app can be downloaded from the right hand side panel. This agent has been tailored to report data to this app only.

Application data can be deleted from QRebel from the settings view. This feature is available only to administrator level accounts.


Comparison select tool

The comparison select tool is displayed in top right corner of the application view. By default, this tool shows the currently compared builds. Pressing the comparison select tool will open the following view:

../_images/xrhub_application_comparisontool.png

Builds displays all stored data for the current application’s builds. To engage comparison, pick the desired target build, then pick another build as the baseline of the comparison.

Tip

QRebel detects application builds and versions based on your configuration. Builds and version can be customized based on your specific rules. For more information, please refer to Configure build names.


Slow requests

The slow requests section displays the requests with the greatest performance impact. Pressing any slow request entry will display the data in a trace diff view for the comparison.

../_images/xrhub_application_slowrequests.png

This report is split per request as follows:

  • Entry point – the entry point for the request in your application.
  • Profile – a graph displaying the difference between latency profiles. Percentiles that became slower are highlighted in red. Hover over the graph for a more detailed view.
  • Increase – average latency increase.
  • Scope – scope of the regression. Indicates the percent of requests that became slower.
  • 99% (MS) – percentile, showing requests that were faster than this value in the current comparison.
  • Hits – total hits registered in the comparison.
  • Jira – create or review Jira issues linked to the current slow request. For more information, refer to Jira integration.

Excessive IO

The excessive IO section displays the requests with increased IO counts. Pressing any excessive IO entry will display the data in a trace diff view for the comparison. This report is split as follows:

  • Entry point – the entry point for the request in your application.
  • Profile – a graph displaying the difference between the entry point’s IO counts. Percentiles with increased IO counts are highlighted in red. Hover over the graph for a more detailed view.
  • Increase – average increase in IO events.
  • Scope – scope of the regression. Indicates the percentage of requests with increased IO.
  • 99% (IO) – percentile, showing requests with fewer IO events in the current comparison.
  • Hits – total hits registered in the current build.
  • Jira – create or review Jira issues linked to the current excessive IO entry. For more information, refer to Jira integration.

Exceptions

The exceptions section displays the exceptions encountered. Pressing any exception entry will display the data in a drill down view. This report is split as follows:

  • Entry point – the entry point for the request in your application.
  • Exception – the exception details.
  • Hits – total hits registered for the exception in the current build.
  • Jira – create or review Jira issues linked to the current slow request. For more information, refer to Jira integration.

Generic Agent download

Generic Agent download allows downloading a generic agent, which can be setup to report to any project and app pair. When downloading the generic agent, the project token and application ID need to be provided for the agent to function. Please use the selector to obtain specific tokens and app IDs as needed.

To download and configure the customized application agent, follow the steps listed on the screen.

../_images/xrhub_agentdownload.png

General settings

QRebel settings provide access to general settings.


Users

User management provides access to a list of all users currently invited into the project. It also allows inviting new members into the project.


Inviting users

To invite users, open Users and locate the Invite members section. Specify the new user’s email and press Invite.