Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enable the average report to display more than one average #309

Open
rschwietzke opened this issue Jan 13, 2023 · 1 comment · May be fixed by #320
Open

Enable the average report to display more than one average #309

rschwietzke opened this issue Jan 13, 2023 · 1 comment · May be fixed by #320
Assignees
@Glenmorangie
Labels
report Change to report or reporting.

Comments

@rschwietzke
Copy link
Contributor

image

To enable more control over the averages displayed, we want to have the ability to configure different moving averages and display them in the same chart, such as:

  • last 5% of the data
  • last 5 min
  • last 5 requests

The 5 here is of course just an example. Besides that different type, you should be able to have more than one of the average displayed, such as last 5 min and last 1 min for instance.
@rschwietzke rschwietzke added the report Change to report or reporting. label Jan 13, 2023
Glenmorangie pushed a commit to Glenmorangie/-309-XLT that referenced this issue Jan 27, 2023
Xceptance#309 Implemented functionality.
5f0f2c5
@Glenmorangie Glenmorangie self-assigned this Feb 1, 2023
Glenmorangie pushed a commit to Glenmorangie/-309-XLT that referenced this issue Feb 2, 2023
Xceptance#309 adjustementes for more user friendly handling.
af325ed
@h-arlt h-arlt linked a pull request Feb 13, 2023 that will close this issue
Open
@h-arlt h-arlt linked a pull request Feb 13, 2023 that will close this issue
#309 Enable the average report to display more than one average #320
Open
@rschwietzke
Copy link
Contributor Author

rschwietzke commented Feb 16, 2023 •
edited

We have to take care of the properties in a meaningful way, here is the PO suggestion.

Base

We have now two types of averages. The one that is in every chart and the averages on the average charts.

Common Average in Charts

image

Average Chart

image

Currently, the moving average for all charts is set like that:

## The percentage of values taken when calculating the moving average series.
com.xceptance.xlt.reportgenerator.charts.movingAverage.percentageOfValues = 5

New Properties

We have to distinguish between the common average and the average chart. The new averages support the following line and data types: percentage, time window (values in the past time window from this current value), and count (last X values)

Common Average

## What type to use
com.xceptance.xlt.reportgenerator.charts.commonAverage.type = percentage|time|count

## What value to set, this 5%, 5 min, count = 5, the latter is always based on what type the average reflects, such as 5 requests, 5 actions, 5 transactions, and so forth. The time value supports our common syntax for time specs, such as 5s 5m 5h or 1:30... Count doesn't require a unit. Percentage uses % without a space.
com.xceptance.xlt.reportgenerator.charts.commonAverage.value = 5%|5m|5

Averages Chart

We will use an index for the charts and this is 1 to 10. Might not make sense to have that many, but if one wants to do that, fine, some limit has to be here, so let's set 10.

com.xceptance.xlt.reportgenerator.chart.averages.1.type = percentage
com.xceptance.xlt.reportgenerator.chart.averages.1.value = 5%

com.xceptance.xlt.reportgenerator.chart.averages.2.type = count
com.xceptance.xlt.reportgenerator.chart.averages.2.value = 100

Defaults

We deliver the following presets. This might change quickly and often depending on the outcome when we see in used in projects or as part of the testing of XLT 7

com.xceptance.xlt.reportgenerator.charts.commonAverage.type = percentage
com.xceptance.xlt.reportgenerator.charts.commonAverage.value = 5%

com.xceptance.xlt.reportgenerator.chart.averages.1.type = percentage
com.xceptance.xlt.reportgenerator.chart.averages.1.value = 5%

com.xceptance.xlt.reportgenerator.chart.averages.2.type = percentage
com.xceptance.xlt.reportgenerator.chart.averages.2.value = 1%

com.xceptance.xlt.reportgenerator.chart.averages.3.type = time
com.xceptance.xlt.reportgenerator.chart.averages.3.value = 5m

Display in Chart Legend

The legend of a chart should say:

  • Average (5%)
  • Average (5m) - this could be always seconds or "min and sec" too, such as 00:05) or just use the value of the property
  • Average (count 5)

Compatibility

The old property (com.xceptance.xlt.reportgenerator.charts.movingAverage.percentageOfValues) is no longer valid and won't be evaluated but when the new is not set, the old default (percentage, 5%) is used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Glenmorangie Glenmorangie

Labels
report Change to report or reporting.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#309 Enable the average report to display more than one average Glenmorangie/-309-XLT
2 participants
@rschwietzke @Glenmorangie