Working with Widgets
What are Widgets?
A widget is a container of the graphs. Web Dashboard is widget based UI. Each widget keeps graph(s) inside it to show in different way depends upon widget type and chart type. There are many operations to do on each widget, such as adding/removing a widget, show/hide graph legends, minimize/maximize widgets, and so on.
Types of Widgets
There are following types of widgets:
- Data Widget: This displays only one value of graph whether it is Average, Maximum, Minimum, Standard Deviation, Last Sample, or Sample count along with the graph name and display name. Different color icons represent different graphs. Vector count is also supported data widget.
- Graph Widget: This displays only graph on that widget. Graph can be of any type, such as Normal, percentile. Based on the graph type, there are chart type, such as Line, Bar, Area, Percentile, Slab, Meter, Geo Map and so on. In Geo map, locations can be displayed by city and state (for US only).
- Tabular Widget: This displays data in tabular form. The data contains Average, Maximum, Minimum, Standard-Deviation, Last Sample, and Sample Count by choice.
- System Health: This is used to configure the threshold values for system health based on various columns displayed in the lower pane of the graph, such as min, max, avg, and so on. Based on the threshold values defined, system health, such as minor, major, or critical is computed and displayed on the graph panel.
Web dashboard introduced various types of layouts. One layout is a combination of different types of widgets of different sizes. There are predefined Layouts bundled with the product. User can create a new custom layout also.
Types of Layout
There are following types of layout available in Web Dashboard:
|Graph||This contains various layouts for graph type widgets, such as 2X2, 3X3, 4X4, and so on.|
|Data||This contains various categories for 3X3 data widgets, such as last sample, max data, avg data, stddev data, and so on.|
|Tabular||This contains various layouts for tabular widgets, such as 2X2, 3X3, 2X1.|
|Mixed||This is a combination of graph, data, and tabular widgets.|
|Custom||This contains some custom created layouts.|
User can select the predefined metrics (such as 2X2, 3X3) from the layout types (as mentioned above) or can define the metrics using the Add New Layout icon . within the Advanced Settings section. On clicking this icon, the Add New Layout window is displayed.
Specify the number of rows and columns. To eliminate scrolling and allow widgets fit to screen, select the Fit To Screen check box. Read the rules for layout creation and click the Create button. The layout is created and displayed on the panel.
User can save a layout for future reference. To do this, click the Save Layout icon . The Save Layout window is displayed. Enter the layout name and its description. Then, click OK. The layout is saved in the Custom Layout section.
Auto Fit Layout
This feature fits all widgets in visible area by resizing them automatically. To view all the widgets in panel without scrolling, user can use this option. It automatically decreases the size of widgets to fit it in visible area and eliminates scrolling. To apply this, click the icon within the Advanced Settings section. In the below image, the scrolling is eliminated after Auto Fit Layout option is selected.
Monochromatic color theme is available and uses different shades of single color for multiple graphs. The monochromatic theme is an extension to the existing pre-bundled color themes in the web dashboard.
- User can apply this feature for all widgets or on specific widget.
- There are many color sets available to apply. If user applies this feature then a default color set based on theme is applied.
- User has an option to have few widgets with multi-color and few with mono colors.
- This feature is not applicable for default template.
Apply Monochromatic Colors (for all widgets)
To apply monochromatic color for all widgets, click the Monochromatic Color icon within the Advanced Settings at the top-right corner of the window. This displays a section with monochromatic color patterns. Select a color pattern to apply the monochromatic colors to all widgets.
This applies the selected monochromatic color pattern to all widgets. If icon is not visible, enable it via Configurations > Configuration Settings > Dashboard Settings > Graph Settings > Enable Monochromatic Color check box.
Apply Monochromatic Colors (for selected widget)
User can also apply monochromatic colors for selected widgets only. To do this, follow the below mentioned steps:
- Select a widget, go to panel setting, and click the Widget Settings option.
2. On the Widget Settings dialog box, go to the Advance Settings section, select the Monochromatic Color check box, click the icon, and select the monochromatic color pattern from the list.
- Click the Save This sets the selected monochromatic color to that widget.
Compare Trend Analysis
Trend compare shows aggregated any specified statics data (Avg/ Min/ Max/ Last/ nth Percentile) value of all measurements and draw a graph of any type.
To apply compare, user needs to select multiple test runs from the test run window and click Compare button.
This displays the Compare Settings window. There are two categories for comparison i.e. side-by-side compare and trend compare. On the top right corner, it displays the selected test runs in a drop down list. The side-by- side compare provide comparison with multiple test runs. Further, there are two major categories, such as Dashboard and Reports. Within the Dashboard section, there are three options i.e. whole test duration, by phase, and advance settings. In whole test duration, it compares between the selected tests for complete duration. In “By Phase” option, it compares between the selected tests for the specified phase only. In the “Advance Settings” option, user can define all the measurements according to the requirement. User can also set the “Preset” options and “View By” options and apply the compare mode.
In the Reports section, user can compare test runs based on all transactions, by template, or can perform some advance settings. In the “Advance Settings” option, user can define all the measurements according to the requirement. User can also set the “Preset” options and “View By” options and apply the compare mode.
Trend compare is performed to obtain a pattern from the already collected information i.e. data from the events that have already been occurred. This helps in predicting future events. From all the specified data, it can display graphs of any type. Trend compare also contains two major categories, such as Dashboard and Reports. Within the Dashboard section, there are three options i.e. whole test duration, by phase, and advance settings. In whole test duration, it compares between the selected tests for complete duration. In “By Phase” option, it compares between the selected tests for the specified phase only. In the “Advance Settings” option, user can define all the measurements according to the requirement. User can also set the “Preset” options and “View By” options and apply the compare mode. Based on the selected option, it displays the trend compare between the selected tests.
Trend Compare – Whole Test Duration (Dashboard)
After selecting the test runs, go to Trend Compare and click the Whole Test Duration radio button. Then, click the Apply button. This displays trend compare analysis for the whole test duration based on the selected test runs.
Trend Compare – Advance Settings (Dashboard)
After selecting the test runs, go to Trend Compare and click the Advance Settings radio button. Then, click the Apply button. This displays the Compare Settings window with advanced options. User needs to provide a measurement name, scenario, test run, preset option, and click the Add button. User can also edit the ‘view by’ and ‘view by value’. Click the Apply button.
This displays trend compare graphs along with the added measurement.
Trend Compare – All Transactions (Reports)
Upon selecting the All Transactions option within the Reports section, Trend Compare Report window is displayed with various sections, comparison of transactions having low, medium, and high response time in graphical format. It also displays various other comparisons in tabular format.
What are Widget Operations
User can perform following operations on widgets
- Stop Session
- Pause Dashboard
- Add Widget
- Remove Widget
- Minimize Widget
- Maximize Widget
- Move Widget
- Resize Widget
- Clicking ‘Stop Session’ aborts the current running session.
Pause / Resume Dashboard
Clicking the ‘Pause Dashboard’ pauses to capture the data from metrics. The data until the dashboard is paused is not displayed on Dashboard. Once the user clicks the ‘Resume’ button, it resumes the data capturing.
Pause Test Schedule: This section is used to pause a running test for a duration or until it is resumed/stopped.
There are following options within this section.
Pause until Resumed or Stopped: The test is resumed until the user resumes or stops it.
Pause for Specified Duration: The test is paused for the duration (in HH:MM:SS format) provided by the user.
- When a test schedule is paused, it stops all scheduling activities. Example: if it is in ramp up phase when user pauses it then it will stop ramping up but load generation will continue with virtual users already ramped up.
- Similarly, if the phase is in ramp down then no further virtual users will ramp down and test will continue with existing users.
- If it is in duration phase, it is extended by the actual paused time. Example: if duration phase was for 1 hour and if it is paused for 10 mins, duration will be 1 hour 10 minutes.
- If all phases are over, the test cannot be paused.
- ‘Pause/Resume Dashboard’ icon is displayed in ‘Advance’ menu of top panel and in drop-down of ‘Last Sample Time’. In addition, the ‘Pause Test Schedule’ and ‘Resume Test Schedule’ button is displayed separately in ‘Pause/Resume Log’ window.
Pause/Resume Log: This section displays the logs of user activities for pausing and resuming the test.
Following data is displayed in tabular format:
- Elapsed Time: The time since the test was running.
- User: The user who has performed the pause/resume operation.
- Action: Action performed, such as Pause / Resume.
- Duration: The pause test schedule, such as ‘till resumed’, ‘stopped’, or specified duration.
- Total Pause Time: The total cumulative time after each pause/resume operation.
- Current Schedule Phases: The current phase when the pause/resume was applied.
The user can perform following operations in this window:
- Pause Test Schedule
- Resume Test Schedule
- Close this Window
- Refresh the records
To add a widget, follow the below mentioned steps:
- On the top-right corner of the Web Dashboard, click the Advance Settings icon and then go to Add Widget icon .
- The widget is added on the widget panel at the last. If there are many widgets already, user may need to scroll down to the newly added widget.
To remove a widget, click the Remove Layout Widget icon corresponding to widget. The widget gets removed from the panel.
To maximize a widget, click the Maximize Widget icon corresponding to the widget. The widget is maximized. To restore it, click the icon.
To minimize a widget, click the Minimize Widget icon corresponding to the widget. The widget is minimized.
To move the widget anywhere to the widget panel, drag it from the title.
To change the size of the widget, stretch it from any of its edge.
User can also perform some operations on panel via panel setting option. To open the panel settings, click the Panel Settings icon or right-click over the graph.
User can perform following actions with the panel settings:
- Widget Settings
- Time Period
- View By
- Show Graph Data
- Pattern Matching
- Add to Custom Metrics
- Show Graph in Tree
- Run Command
- Advanced Settings / Open Merge
- Monochromatic Color
In this section, the user can perform various setting related to widgets. The widgets are displayed in the Dashboard based on the configured settings.
To open the Widget settings panel, right click on a widget and select the Widget Settings menu item.
Metric: This value is used to get data from Web Dashboard
Log: This value is used to get data from NetForest.
- Environment: This displays the list of environment, which is sent by NF REST. The user needs to select one environment in which query is to be executed.
- Index Patterns: This displays the list of indexPattern, which is sent by NF REST. The user needs to select one indexPattern in which query is to be executed.
- Query Type: There are two options:
- Saved Query: When user selects this option, one NF REST is executed, and a list of saved queries is displayed from Netforest.
- Custom Query: When user selects this option, the user need to write query in the Query input box.
- Query: This changes according to Query Type, if user select Saved Query then query list is displayed here, and if user selects Custom Query, the user needs to write query in the input box.
Select the Widget type, such as Graph, Data, Tabular, System Health, or Label. The next selection is based on the Widget type selected. Here, we are describing about further options that are displayed on the selection of a particular widget type.
Widget Type – Graph
Graph Type: There are following options under this:
- Normal: This contains all the graphs. In case of normal graph only, user needs to select the formula type too, such as average, min, max, count, and sum count. User can add multiple formulas also. When a user selects graph type other than ‘Normal’ graph type, the ‘Graph Sample Filter’ option is disabled.
- Percentile: This contains only the percentile graphs. A percentile is the value of a variable below which a certain percent of observations fall.
- Slab count: Slab count graph is used to count number of samples in a particular time interval.
- Category: The graphs belongs to this category are – Stacked area chart and stacked bar chart.
- Correlated: Using correlated graphs, user can observe a correlated trend of specific graphs. This graph can be plotted into three chart type, such as Time Series, Bar, and Area chart. Upon selecting this option, user also needs to provide the correlated properties that includes minimum bucket, maximum bucket, total buckets, baseline graph, and left position.
Chart Types: There are following chart types:
- Line Chart: The charts displayed in the form of lines.
- Bar Chart: In this case, line chart is converted to Bars. User need to specify the criteria, such as Avg All, Avg Top 5, Avg Top 10, or Avg Bottom 10.
- Pie Chart: It is useful in case of multiple graphs. If one graph is converted into Pie, then a simple circle filled with one color is displayed. It is needed to take average value or Last value of graph. If graph type is cumulative then system takes last sample value otherwise average value.
- Area Chart: An area chart displays graphically quantitative data. The area between axis and line are commonly emphasized with colors and textures. Area chart is used to represent cumulative data using numbers or percentages over time. Use the area chart for showing trends over time among related attributes. The area chart is like the plot chart except that the area below the plotted line is filled in with color to indicate volume.
- Stacked Area Chart: Stacked Area chart means area chart of each graph is stacked on each other.
- Stacked Bar Chart: In this case, graph is converted to Stacked Bar chart. Stacked bar chart means bar of each graph is stacked on each other. It is useful in case of multiple graphs. If one graph is converted into Stacked Bar, then it looks like normal Bar graph.
- Dial Chart: Purpose of Dial Graph is to easily analyse the data in online mode how data variation is coming and to view samples of data in Dial Chart except Line Chart. Sample of data is shown in dial chart through Dial Tick Interval. User need to specify the criteria, such as By last value or By Avg value. User also need to set the properties, such as – Minimum, Maximum, Threshold, Warning, and Critical.
- Meter Chart: Purpose of Meter graph is to easily analyse the data in online mode how data variation is coming and to view samples of data in Meter Chart except Line Chart. Sample of data is shown in meter chart through Dial Tick Interval. User need to specify the criteria, such as By last value or By Avg value. User also need to set the properties, such as – Minimum, Maximum, Threshold, Warning, and Critical.
- Donut Chart: Donut chart is represented in the form of a donut. User needs to specify the criteria either last or average.
- Dual Axis Chart: Dual Axis charts are useful for comparing trends in two data sets whose numeric range differs greatly. A dual Axis chart allows a user to summarize or plot two y-axis variables that have different domains. For example, user can plot the available memory on one axis and the free memory on another axis.
Note: User can edit label of Y-axis in Dual Graph from Advance settings of Widget Setting.
- Dual Axis Bar Chart: A dual bar chart allows a user to summarize or plot two y-axis variables that have different domains. For example, user can plot the Available Memory on one axis with Bar graph and the CPU Utilization on another axis with line graph.
- Line Stacked Chart: If user wants to see combined graphs of a stacked bar and line chart, then Line Stacked chart is used. In Line Stacked chart, first selected graph displays as line graph and other displays as Stacked bar graph.
- Dual Axis Area Chart: In this type of graph, one graph is displayed as area chart and another graph is displayed as line chart. It is also known as multi-line area graph.
- Dual Axis Stacked Bar Chart: This chart provides the data in the widget as one of the data being Dual axis line and another being Stacked bar.
Widget Type – Data
On selecting Data as Widget type, user needs to select the Data Field name, such as minimum, maximum, average, and so on. The data field name is filled in the display name field. User can change the display name according to requirements.
Widget Type – Tabular
On selecting Tabular as Widget type, user needs to select table type (Graph based stats/vector based stats) and the fields, such as minimum, maximum, average, and so on. In case of vector-based stats, user can enable the view of rank and score.
Widget Type – System Health
This is used to configure the threshold values for system health based on various columns displayed in the lower pane of the graph, such as min, max, avg, and so on. Based on the threshold values defined, system health, such as minor, major, or critical is computed and displayed on the graph panel.
To understand this better, let us take an example:
Minimum - 12.00, Maximum - 45.00, and Average - 19.85
Now, we are configuring the threshold values in the System health section based on the ‘Average’ field:
Based on the above settings, the graph is displayed with the ‘Critical’ status as the threshold value for critical condition is configured greater than or equal to 19, which actually exists. As there is only one graph, the critical and major percentage is defined as 100%. If there would be multiple graphs (merged graphs), then we need to specify the percentage value accordingly.
In case of merged graphs, user can also specify the health rules. If the percentage of graphs exceeds the threshold values, the system health is considered based on the criteria and changed accordingly, whenever there is a dip or rise in the percentage of graphs.
Here, there are 11 graphs in the graph panel with different average values. If we apply the same settings as we did for single graph, but change percentage to 20% for critical and major both then it means that if 20% of the graphs exceeding the critical threshold average valued i.e. 19 then it is termed as critical.
The status displayed in the graph panel as critical.
Favorite parameterization is now supported for Tabular, Data, and Health widget. This can be achieved by selecting a particular row in tabular widget and then using “Page Dashboard” drill down option. For other Data and Health widgets, user can directly select the “Page Dashboard” option under Drilldown menu.
It is used for Favorite Parametrization from One widget of current favorite to another favorite .It can be done using Widget Drill Down.
For Example: User have two favorites Fav1 and Fav2. Fav1 contains a G1 graph of metadata T1 > S1 and Fav2 contains a G2 graph of metadata T2 > S2. G1 and G2 are related to each other like CPU Utilization and Memory consumption. Let suppose Fav1 is loaded on the dashboard , user got a spike on G1 for metadata T2> S2 ,same case need to analyse in G2 ,in this case we can directly go to Fav2 by Page Dashboard option without loading or dragging graph from graph tree.
Steps to apply Page Dashboard:
- Load the Favorite.
- Open Widget settings > Widget Drill Down.
Enable Widget drill down option and save the favorite, which needs to be mapped.
- Disable Parametrization: When we clicked on Page dashboard, Parameterization can be done on destination favorite according to selected metadata on source favorite. If a user enables Disable Parametrization then Parametrization can’t be applied on destination favorite only favorite will be open.
Selected metadata from lower panel:
Redirection of Favorite:
Dynamic Color in Lower Panel based on Severity
Along with the graph, the colors in the lower panel also change based on the severity. The servers that are in Critical condition are displayed in red color.
The servers that are in Major condition are displayed in orange color.
The servers that are in Normal condition are displayed in green color.
Widget Type – Label
Label widget type is used to create a blank widget with just a label in it.
The main purpose of this widget type is to provide a heading / title to a group of widgets and place those widgets below this label widget.
Further to this, the user can perform formatting on the created Label widget, such as bold, italics, underline, font size, font color, text alignment, and many other formatting.
Widget Settings – Legend Position
This is used to set the legend position for graph(s) on a widget. To enable this, select the Show Legend check box and then select the legend position (left / right / bottom) from the drop-down list.
The legend position is set based on the selection.
Widget Settings – Advance Settings
In this section, user can perform following operations:
- Edit Caption: Here, user can edit the default caption of the graphs.
- Widget Drill Down: Widget drill down is used for parameterization according to the selected panel.
- Monochromatic Color: Using this, user can apply monochromatic color for the selected widget.
- Disable Parameterization: Using this, the user can disable parameterization applied on the scripts.
- Compare with: According to baseline, it creates three lines CRITICAL, MAJOR, and MINOR. For Fixed Trend in Auto Baseline, the user can only plot ‘Line’ chart in a widget for a given graph data range by setting Critical, Major, and Minor Baseline values from the Widget Setting window. The user can set these value and can save them as a favorite. It also works with zoom charts.
In Auto Baseline, another options are ‘weekly’ and ‘daily’ trend at widget level. In weekly mode, comparison is done on all the graphs with data of the previous week for same graphs, in same time frame. Similarly, in the daily trend mode, comparison is done with the previous day data. Below is an example showing comparison with last day data on applying baseline.
Shift back data: Here, the user can specify the duration (in minutes) by which the X-axis (Duration/Time) of the graph will shifted back by selected Duration.
This is used to set the display of the data widget that includes font settings, color setting, and various other settings.
With this section, the user can:
- View / Hide Title bar
- View / Hide Icon
- Set the decimal places for the data value
- Set the Label color, value color, and background color.
- Set the font size, font family for display and for data value.
Advance Settings – Tabular
In this section, all other details are similar as described in Advance settings for Graph type widget.
Advance Settings – System Health
In this section, all other details are similar as described in Advance settings for Graph type widget.
This is used to set the display of the System Health widget that includes font settings, color setting, and various other settings for Status, Value, and Title.
This drop-down is used to see Top/Bottom graphs based on Average, Minimum, Maximum or Last value. It is supported for all widget types and chart types.
Widget Settings – Advance Filters
This section contains two further sub sections: Panel Graph Filter and Graph Sample Filter.
Panel Graph Filter
To enable the panel graph filter and display them in widgets according to the specified criteria, select the Enable Panel Graph Filter check box. Further, there are following filter options for showing graphs with specified values:
- All Non Zero: When enabled, graphs with non-zero data is displayed.
- All Zero: When enabled, graphs with zero data is displayed.
- Advanced: In this case, user can apply advanced level filtering. User can discard the un-desired graphs by using this option. There are following filter options, such as <, >, <=, >=, Top, Bottom, In between, which helps to achieve the desired output. User can filter graph values by Min, Max, and Avg value of its graph data. User can also use the Include or Exclude options to get the filtered results. Include/exclude options includes/excludes the graphs that lies within the specified values. For example – if we try to find the graphs that has values between 50-100, then on include, system displays such graphs that has values from 50-100 and exclude option skips those results that contains graph values from 50-100 and displays the rest graphs. To enable the filters, user needs to enable the toggle button.
Graph Sample Filters
A user can filter graph samples based on the filters defined for graphs. For this, a user needs to perform the following actions:
- Select the Enable Graph Sample Filter check box.
- Select the graph from the drop-down list.
- Select the comparison operator (>=, <= and, In Between) and its value.
- Click Add.
The base graph is displayed based on the filter value set in the Advance filters and rest graphs are displayed with the value at that point of time.
The user can also set criteria for multiple graphs in the same manner. This works as an AND operator and graphs are displayed based on the matching criteria of all the graphs in the list.
The output in widget is displayed as below:
You can get the reports according to the applied graph sample filter in the web-dashboard. For this, right click the Widget (on which filter is applied) and go to Reports.
Select the Report Type, View Type, Widget Info, and click the Generate Report button. The report is generated with the applied filters as displayed in the widget.
- When a user selects graph type other than ‘Normal’ graph type, the ‘Graph Sample Filter’ option is disabled.
- A user can now edit filter configuration of a graph sample by using the ‘Edit’ option in the ‘Action’ column. In addition, a confirmation message is displayed while deleting any configuration.
Using correlated graphs, user can observe a correlated trend of specific graphs.For example, user wants to analyze the Page Response Time as per Page Load increase.
Let’s understand this implementation by an example- Let we have 2 graphs Page Response Time (G1) and Page Load (G2) and their data are:
[00:00:00 00:00:10 00:00:20 00:00:30 00:00:40 00:00:50 00:00:60]
[ 1 , 4 , 2 , 5 , 1 , 4 , 6 ] G1
[ 20 , 50 , 20 , 50 , 10 , 40 , 60 ] G2
Let’s count for each sample is 1.From above data, we can observe the Page response against Load.We have to plot a correlated chart so we’ll packetize the data as follows:User has given min value of bucket 10, max is 50 and number of bucket are 5.X -axis will look like
10 20 30 40 50
Here all Load whose value is greater than 50 will fall in this bucket.Values that lie in bucket are as follows – Bucket Values
20 1, 2
30 No values
50 4, 5, 6
Now we’ll draw a series using weighted average of values on each bucket.That is, if we have to plot a sample for 50th bucket then we’ll calculate weighted average like (4 *1 + 5 *1 + 6*1) / (1 + 1+ 1) = 4.66.We’ll do this for all graphs. For this, we have introduced a new graph type Correlated and this graph can be plotted into three chart types – Time Series, Bar, and Area chart. This also have a configuration GUI where user can define the Base line graph, min, and max value of bucket, number of buckets. This bucket values are representing the baseline graph values. Now, user can also specify the Y – axis graphs and can also set which graphs should be shown on left Y- axis and which on right Y -axis.
In correlated graph, we can see the value of a graph with respect to the baseline graph buckets.
If two graphs are there ‘Free memory’ and ‘CPU utilization’, where ‘CPU utilization’ is the baseline graph.
Then, average of the values of ‘Free memory’ that falls in the Bucket range of ‘CPU utilization’ is shown in the graph.
Steps for creating correlated graph
- Select a widget and merge two or more graphs on the widget.
- Open widget settings and select graph type as “Correlated Graph”.
- Select Baseline graph and values of minimum bucket, maximum bucket, and Total bucket.
- Select “Left position” and “Right position”, and save it.
Time Period and View By applied on Dashboard is visible on top panel, which will be loaded from favorite initially.
If user clicks on Time Period from the Panel settings, then a new window is displayed to change Preset and View By.
Preset option is used to apply time like Last whole scenario, N Days, Last N Weeks, Last N Months, Event Day.
There are following options in this:
- Last 10 minutes: This shows the graph data of last 1 hour in graph series.
- Last 1 hr: This shows the graph data of last 1 hour in graph series.
- Last 2 hrs: This shows the graph data of last 2 hours in graph series.
- Last 4 hrs: This shows the graph data of last 4 hours in graph series.
- Last 6 hrs: This shows the graph data of last 6 hours in graph series.
- Last 12 hrs: This shows the graph data of last 12 hours in graph series.
- Last 24 hrs: This shows the graph data of last 24 hours in graph series.
- Last Specified Minutes: User can see last N minutes’ data in graph series.
- Specified Time and Phase: Using this option, user can see graph data for specified Time and Phase in graph series.
- Whole Scenario: This shows the graph data of Total Run Time.
- Custom: In this case, user needs to specify the time format (elapsed/absolute) and further specify the start time and end time accordingly.
The user can save any specified range of the time period as an event name and can apply the saved time period in future. The saved event preset is displayed in the drop-down list with other system specified time period presets, such as Last 10 min, Last 1 Hour, and so on. The user can analyze the data in the dashboard for a particular time period just by selecting saved events from the time period window rather than selecting presets or writing date/time for custom.
Running: Upon selecting this check box, the last updated sample is included in the graph result based on the view by value selected.
View by: This option is used to view the graphs aggregated by a specified interval. There are following options – 5 min, 15 min, 30 min, 2 hours 30 min, Auto, custom. By default, ‘auto’ is selected. In custom mode, specify the minutes and seconds in the multiple of sample interval.
To apply time period on all widgets, select the Apply time period on all widgets check box.
Discontinued metrics are those metrics whose data is dropped in between of the test run. These metrics are skipped in the current view of graphs. It is neither displayed on the graph panel nor displayed in the tree structure. All such metrics can be displayed using the Show Discontinued Metrics feature of Web Dashboard.
The default status of ‘Show Discontinued Metrics’ check box is enabled/selected in Excel report. This enables a user to get the data of discontinued metrics too (by default) while generating an Excel report.
On opening the web dashboard for a specific test run, GUIDevTier and QATier tiers are displayed (along with their associated graphs) under SysStats Linux Extended group.
On enabling the Show Discontinued Metrics feature, the discontinued metrics are added in the tree view.
This signifies that metrics/graphs of Cavisson group are discontinued in between due to certain issue. To view the graphs, expand the node. The graphs are displayed on the graph panel.
Note: For Discontinued Derived Metric Name, the error messages are displayed based on the following cases:
- Case 1: When ‘Show Discontinued Metrics’ is enabled
Message: ‘Derived Metric Name already exists in Group. It may be possible that it is in Discontinued state. Please enter different derived metric name’
- Case 2: When ‘Show Discontinued Metrics’ is disabled
Message: ‘Derived Metric name already exists in the group. Please enter the different derived metric name’.
Searching Discontinued Metrics
Discontinued metrics/graphs can also be searched using the search panel.
User can apply View by from right click menu of the widget. However, only best view by options are provided, which are producing samples between 20 and 100.
View By – 1 Minute
When a user zooms any graph, ‘View by’ option along with time period is displayed.
Show Graph Data
- To view the graph data, click the Show Graph Data menu item within the Panel settings menu. The graph data is displayed with information, such as sample time, running Vusers, and active users..
- To navigate to the pages, use the navigation button displayed at the bottom.
- User can also download the graph data in various formats, such as PDF, Excel, or Word.
- To close the window, click the Close button.
Pattern Matching (correlation) is the degree to which two or more attributes or measurements on the same group of elements show a tendency to vary together. Pattern matching feature is used to identify all those graphs that contains a similar pattern. User can correlate two or more graphs from Dashboard.
Prerequisites for Pattern Matching
- Baseline graph should be there.
- Other graphs should be selected for pattern matching (can be one or more than one).
- By default, threshold value is 80.
Steps for Pattern Matching
User needs to follow the below mentioned steps for pattern matching of graphs:
- Select a graph where a spike is recognized, the graph is displayed on the widget panel.
- Zoom the graph where the spike is noticed.
- Go to Panel Settings and click Pattern Matching
- The Pattern Matching window is displayed. The selected graph is considered as baseline graph and pattern matching is performed based on the baseline graph.
- Specify the threshold value, by default it is 80.
- To include inverse pattern matching in the comparison criteria, select the Inverse Pattern Matching check box. By default, it is selected. Inverse pattern matching compares the baseline graph with anti-graphs also. It means, the graphs with matched pattern in the reverse direction (-ve values) are also compared.
- Select the category, such as all graphs, selected graphs, or selected catalogue.
On selecting this option, baseline graph is compared with all graphs. To skip the cumulative and response time graphs, select the check boxes respectively.
On selecting this option, user needs to select graphs for match pattern using the arrow button.
Here are two options All and Specified for inclusion of graphs. On selecting All option, all the selected graphs are considered for comparison. On selecting Specified option, Specified Indices Selection window is displayed where user can select the specified graphs. This window contains two tabs – Specified and Advanced.
On the Specified tab, user can select the indices from the list of available indices using the Add button.
On the Advanced tab, user can specify the vectors based on selection. User can also apply pattern for the same. On applying, the Specified text box is filled with the mentioned criteria.
User can save graphs as Catalogue by clicking the Save As Catalogue button. Once saved, it can be used by selecting the Select Catalogue option.
- On selecting the category (All/Specified/Catalogue), click the Match Pattern In this case, we have selected All.
- The graphs with matched pattern are displayed.
Note: Pattern Matching graphs are sorted based on the matched percentage with the baseline graph. Graphs with high match percentage are displayed first in the list.
- First graph is the baseline graph and rest are the those graphs whose pattern is match with the baseline graph. Following details are displayed on this window:
- Base Metric Name
- Start Date Time
- End Date Time
- Threshold value
- Related Metric Count
- User can view the correlated graphs with percentage by clicking the related metric count. To download this report, click the Download button.
Add to Custom Metrics
- To add graphs to the custom metrics, click the Add to custom metrics menu item. A dialog box is displayed prompts to add graph in custom metrics.
- Enter the group name for storing the graphs in custom metrics, for example VUsers.
- Click OK. The group is added in the custom metrics.
Show Graph in Tree
- Graphs can also be viewed in the tree structure. To do this, click the Show Graph in Tree menu item, the graph is displayed in the tree structure in the Standard metrics section.
To generate a report, follow the below mentioned steps:
- Click the Reports link under the panel settings, a section for report generation is displayed. Here, user can select the report specifications based on the requirements.
- Select the report type from the list, such as Stats, Compare. User can select the report type as Compare only when compare is applied in Web dashboard. This is beneficial to generate the report on minimal parameters.
- Select the report view type, such as word, HTML, tabular from the list of view types.
- Select the widget info to specify whether the report is to be generated for selected widget or all widgets.
- To include the charts in the widget, select the Include Charts check box else clear it.
- Click the Generate button to generate the report.
|If pop-ups are blocked, unblock the pop-ups to allow the browser to download the reports.|
Example – Here is a sample configuration for the report generation.
The above configuration generates a Stats report in tabular format for all widgets including charts.
The report displays various details, such as test run time, applied time, test run duration, and so on. This report is categorized into two sections i.e. General report and Percentile report. Each section contains various other details. Clicking the hyperlink displays the corresponding chart.
- To download a graph, click the Download As menu item.
- Select the download format from the list of items. User has options to download the graph in multiple formats, such as:
- The file is displayed based on the download option selected. For example, here we have selected PDF.
This feature is used to run command on server. Follow the below mentioned steps to run command on server:
- Click the Run Command menu item under panel settings. The Run Command window is displayed.
- Select tier name, server name, group name, and command name.
- Other options also get enabled based on the selection, such as for process management group, the options – select all process, full format, long list, and show threads get enabled. User can select them according to requirements.
- User can also apply certain filters and can save the output on server.
- Post specifying the details, click the Run button to run the command. The output gets displayed in the Command Output To refresh the command, click the Refresh button.
Advance Open/Merge Metrics
This section is covered under Advance Open /Merge Metrics section in Advanced Options.
Form here, user can enable / disable the application of monochromatic colors on the panel. If it is “On”, monochromatic colors can be applied otherwise not.
Overlay Alerts displays stats of the alert generated in the graphs. User will get the alert events from Alert History. Based on its time stamp, user will get annotations on the graph, to show the different types of Alerts (Critical / Major / Minor / Normal).
There are different representation for different type of Alerts:
- Red colored flags for Critical Alerts
- Orange colored flags for Major Alerts
- Yellow colored flags for Minor Alerts
- Blue colored flags for Normal Alerts
Viewing Overlay for Alerts
- Right-click on a widget panel and go to Overlays > Alerts > Add Overlay.
Note: This option is visible for graph type widget only.
- Upon clicking Add Overlay, Alert Overlays dialog box is displayed.
3. Select the severity level from the available options:
- All: All severity level is considered for displaying overlay alerts.
- Critical: Only ‘Critical’ alerts are considered and are represented with ‘Red’ color.
- Major: Only ‘Major’ alerts are considered and are represented with ‘Orange’ color.
- Minor: Only ‘Minor’ alerts are considered and are represented with ‘Yellow’ color.
- Normal: Only ‘Normal’ alerts are considered and are represented with ‘Blue’ color.
- Click Apply. This displays the overlay alerts with the specified representation.
There are two types of tooltip in Alert Overlay. The first one displays on hovering over the flag. This tooltip shows the graph information along with the maximum alert severity and its severity.
The second tool-tip displays on clicking the flag icon. This displays the detailed information of the applied overlay in tabular format.