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.

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

FISH-6 Multiple series in a widget (editable series) #16

Merged
merged 3 commits into from
Jul 7, 2020

Conversation

jbee
Copy link
Contributor

@jbee jbee commented Jun 30, 2020

Summary

This PR adds a new feature to monitoring console. It allows to use one or more series per widget. This also means the series now is editable so it can be changed.

When a widget initially is added to the page it will always use one series. Further series then can be added by opening the settings for the widget and adding further series. The settings to do so is keep rather basic at this point as a future task will create a wizard soon that replaced the multi-text field used now.

Adding a Series

To add another series open the settings of the widget (click title) and press the + button next to the Series property field. This adds another text field below the existing one where the name of the series is stated. To find the name one can expand the Page settings and use the Add Widgets property to prefill the last of its text field with the full series name (do not use the Add button there as this will add a new widget with the series but copy & paste its name to the empty text field of the Data => Series property.
This is not very convenient to use but as mentioned a wizard will soon replace this basic way of selection.

Removing a Series

To remove a series just blank the text field for Data => Series and both the field and the series are removed. It is intentionally that this will not remove the last/only text field. Again this very simple method was chosen as the wizard added soon will make this obsolete again.

Multi-Series Widget Legend, Colouring and Title

When a widget has multiple series the legend mentions both instance (e.g. DAS) and metric (e.g. ThreadCount).

By default series from the same instance will be coloured identical. To get the colouring from the screenshot the user can switch Coloring to Instance and Series. This is intentionally not "smart" but up to user configuration to avoid corner case issues.

Similarly the title of a widget expects the user to provide a meaningful multi-series title using property Widget => Display Name. If no such name is provided but multiple series are used the title shows Multi-Series without Display Name to give the user a hint of what he is expected to do. Note also that the title will not update without a page change when switching between one and multiple series and/or providing a Display Name. This is a known limitation.

Limitations

It is intentional that this feature only allows to use multiple series that share a common axis. That means they all represent a count, a byte size or a percentage but not different of these. Or in more technical terms: they share the same unit. While the user could configure multiple series into a widget that do not share a unit there is no way to select a unit per series as the unit is linked to the widget. This was a known limitation when this work was started as we did not want to spend the significantly higher effort entering multi-axis graphs. At this point this also is not plant to ever happen as the complexity required does not justify the niche feature this is in the context of application server monitoring.

Testing

As changes only affect the webapp no special Payara server build is needed (apart from using a server with latest MC modules).
Simply manually build the webapp and manually deploy the application war file.

Testing Performed

Manual testing of the feature as shown in below screenshot:
screenshot-x1_8080-2020 06 30-15_12_21

Try to:

  • add a series to a widget
  • remove that series again by blanking the text field
  • add multiple series to a widget
  • remove some other series again

Check:

  • when erasing the last text field it does not disappear
  • when using a non exiting series name(s) there are simply less matches
  • when there are not matches (only non exiting series name) "no data" is shown
  • when multiple series are used the legend states both the instance (DAS) and the metric (e.g. ThreadCount)

@jbee
Copy link
Contributor Author

jbee commented Jul 6, 2020

@Pandrex247 you appear to be doing the review already so I picked you ;)

Copy link
Member

@Pandrex247 Pandrex247 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After fixing the issues with the funny 1.2 release, seems to work 👍

@jbee jbee merged commit 879f857 into payara:master Jul 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants