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

Job Analytics panel charts dynamically configurable. #1517

Merged
merged 3 commits into from
Mar 30, 2021

Conversation

jpwhite4
Copy link
Member

@jpwhite4 jpwhite4 commented Mar 25, 2021

Motivation and Context

The job analytics panel had a hardcoded number of analytics plots. This change
makes it (slightly) more flexible in that it wil only show the number of
analytics that are actually returned by the rest call (up to a hard-coded
maximum which is now 6).

This change now allows different jobs to have a different number of analytics.
However, the main motivation for the change is to make it easier to
configure the charts that are displayed because now they are managed in one
place rather than having hardcoded values in multiple places.

One of the reasons why a hardcoded maximum is still present is due to
the original design of the panel. The plots are all instantiated in the
constructor, but the number of charts with data is only known once the
rest call has returned. The ideal design would wait until the rest
call has returned before construting the object, but that would require
a substantial rewrite of the software. Instead we slice off the extra
charts that are not needed.

Tests performed

Manually tested on metrics-dev. See also the pull request in supremm ubccr/xdmod-supremm#273

The job analytics panel had a hardcoded number of analytics plots. This change
makes it (slightly) more flexible in that it wil only show the number of
analytics that are actually returned by the rest call (up to a hard-coded
maximum which is now 6).

This change now allows different jobs to have a different number of analytics.
However, the main motivation for the change is to make it easier to
configure the charts that are displayed because now they are managed in one
place rather than having hardcoded values in multiple places.

One of the reasons why a hardcoded maximum is still present is due to
the original design of the panel. The plots are all instantiated in the
constructor, but the number of charts with data is only known once the
rest call has returned. The ideal design would wait until the rest
call has returned before construting the object, but that would require
a substantial rewrite of the software. Instead we slice off the extra
charts that are not needed.
@jpwhite4 jpwhite4 added bug Bugfixes Category:Job Viewer Job Viewer labels Mar 25, 2021
@jpwhite4 jpwhite4 added this to the 9.5.0 milestone Mar 25, 2021
jpwhite4 added a commit to jpwhite4/xdmod-supremm that referenced this pull request Mar 25, 2021
The walltime accuracy analytic is added bringing the total number up
to five. There is a corresponding change to the core to allow the
job viewer to display these: ubccr/xdmod#1517

A new documentation page is also added to explain how to configure
which analytics are displayed. This is obv. not the full configurabilty
that we ultimately would like to have, but at least should head-off
some of the more common support requests.
@jpwhite4 jpwhite4 requested a review from ryanrath March 25, 2021 21:03
@jpwhite4 jpwhite4 merged commit 23476b7 into ubccr:xdmod9.5 Mar 30, 2021
@jpwhite4 jpwhite4 deleted the var_ana branch March 30, 2021 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bugfixes Category:Job Viewer Job Viewer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants