Interactive Dashboard Getting Started

What is Interactive Dashboard


The Grafana interactive dashboard is a one stop platform to visualize all your tests data. Out of the box it provides you the ability to view different test metrics like-

  • Number of Passed/Failed tests
  • Percentage of Passed/Failed tests
  • Aggregate statistics like-
    • Average response time for the test report
    • Number of requests per sec/min/hour/day
    • Standard Deviation, 95th and 99th percentile delay values for the test report
    • Maximum and minimum delay and
    • Total execution time of the entire test run
  • Top 100 most delayed passed and failed tests
  • Top 10 response delays
  • Request failures grouped by method
    • Displaying number of failures for each method in the test report
    • The last failure occurrence time

Downloading and Running Dashboard

1. Download the latest version of Dashboard as a zip file from the Download page. Unzip to a folder and start the docker-compose YAML file as below.

2. On MacOs/Linux, use the following command

$ bash start.sh

3. On Windows use the following command

> docker-compose up

4. Go to a browser and navigate to

http://localhost:3000

Dashboard Home


  • This is where all dashboards are listed. When you login for the first time you can find these dashboards under the Dashboards -> Manage tab as shown in this image-

image

Zerocode Samurai Themes


On the main dashboard we have provided an option to change the theme from an option of preset themes as shown below-

image

You can simply click on the theme name to change the dashboards look and feel

  1. Zerocode theme
  2. Dark Theme
  3. Light Theme

List Of Dashboards


The following dashboards are available for users to view and analyze the test results:

image

  • Zerocode Samurai Dashboard is the primary dashboard which covers the important test metrics for the entire test report

  • The Samurai All Test Details and Samurai Load Statistics are secondary dashboards. These can be viewed either directly or as a nav-link from the Zerocode Samurai Dashboard

Full Dashboard view


The primary dashboard looks as shown below-

image

Overview


Here we display

  • Total requests
  • Passed tests
  • Failed tests

image

Throughput Section


Divided into following three categories.

  • Speed
  • Performance
  • Duration

image

A user can quickly infer the following key metrics from the table above-

  • Average response time for the test report
  • Number of requests per sec/min/hour/day
  • Standard Deviation, 95th and 99th percentile delay values for the test report
  • Maximum and minimum response delay and
  • Total execution time of the entire test run

PASSED TESTS | 100 LONGEST DELAYS (MS) VS TIME


Passed

  • The request-time vs Response-delay shows the longest delayed requests for the passed tests.
  • Hover over each bar to get the corresponding test values like correlation-id, request-time, response-delay, method and result.
  • User can even copy these values for further analysis of an individual test request
  • The high limit is customizable and it highlights all the tests that have surpassed this limit

FAILED TESTS | 100 LONGEST DELAYS (MS) VS TIME


Failed

  • Works specifically for Failed tests and shows the same metrics as in the case of passed tests
  • User can customize the high limit to either a fixed or a variable value and find out which tests are above this par limit AND has failed with the help of this graph

10 LONGEST RESPONSE DELAYS (MS) | PASSED OR FAILED


image

  • This panel shows the top 10 longest delayed tests for the overall report along with additional information like-
    • Correlation-Id
    • Request time stamp
    • Response delay for the test
    • Name of the method

REQUEST FAILURES by Method


image

  • The failed test information for each method are clubbed together with useful information like-
    • Name of the failed method
    • Last failure (last time at which the failure occurred for that method)
    • Total number of failures

Show Detailed Graph Button


  • The Passed Tests and Failed Tests panel can also be expanded to give a detail overview of the entire report over the request time data

DetailedGraph

When a user hovers over the highlighted button and clicks the link, it takes the user to the Response Time Tracking panel as shown below

ResponseTimeTracking2

Filtering Results


After Landing on the  Samurai All Test Details  dashboard, the user can further filter the graph by metric as shown below using the dropdown- Select Metrics

image

  • The options can be a mix and match of one or multiple metrics like the test method or test result

Filtering by Timestamp Range


  • By default the graph displays the entire range of datasets as coming from a data-source like a csv report
  • User has an option to override the time limit (X-axis values) and specify the time filter as shown below-

image

TimeFilter

Copying CorrelationId


A test can be individually verified by a unique Id called as the CorrelationId. This Id lets the tester query any test request further for detailed analysis like

  • The type of test
  • The result of the request
  • What was the delay for this request etc.

This Id can be copied from-

  1. The Zerocode Samurai dashboard panels by hovering over the tooltip and triple click on the field to select and then copy (shown below)-Copy_CorrelationId
  2. From the Response Time Tracking panel
    1. The failures are shown as annotation (on the X-axis).
    2. Find the relevant data point which has failed
    3. Go the annotation underneath and hover over the red color arrow button
    4. A tooltip will pop up with timestamp, correlationId and method name for the failed test
    5. Triple click to select and then copy the Id (shown below)

image

    Copy_CorrelationId2

    NOTE: The correlationId button can also be toggled on and off from the top header. This will disable all the annotation for the failed tests from the graph

    image

    Zoom In Zoom Out


    The Samurai All Test Details dashboard can be further drilled down to zoom in on a particular range of tests

    • To Zoom in on a section of the graph, drag the mouse
    • The section will be expanded to fit the graph as shown below-

    Zoomin

    • To Zoom out simply look for the zoom out button on the top right hand corner of the graph-

    image

    Navigating to data from left to right


    In a zoomed-in section, the user can also navigate to left and right using the left right navigation buttons-

    left_right

    Virtual Users Panel


    For a load test report, a user may want to know that-

    1. How many users were fired per second?
    2. What is the average load of users per second
    3. Minimum number of users at any given time
    4. Or maximum number of users at any given time

    These metrics can be easily visualized using the Samurai Load Statistics dashboard

    SamuraiLoadStatistics

    How to Navigate to the Samurai Load statistics dashboard?


    1. Hover over the link near the "Performance" panel (shown below)-

      Navigate1
    2. Click on the Show Virtual Users link

    3. The user is navigated to the Samurai Load Statistics dashboard

      Samurai_Load_stats
    4. Click on Zoom to data to zoom in on the data range for the given load test report