Add chart displaying available applications

[cbartz]

Applicable spec: n/a

Overview

1. Rename flavour to application in the dashboard panels.
2. Add a chart close to the input variable listing all applications.

For the short-term board, list all available runners (idle runners after last reconciliation).

For the long-term board, show all runners created per application.

Rationale

1. The term flavour is nowhere well defined, and we are really referring to the charm application that manages the runner instances.
2. The panel should help to list all available applications which can be filtered.

Juju Events Changes

n/a

Module Changes

n/a

Library Changes

n/a

Checklist

• The charm style guide was applied
• The contributing guide was applied
• The changes are compliant with ISD054 - Managing Charm Complexity
• The documentation is generated using src-docs
• The documentation for charmhub is updated.
• The PR is tagged with appropriate label (urgent, trivial, complex)

[arturo-seijas]

I think the jobs per application metric would be better displayed as a bar chart. The current chart doesn't seem to intuitive to me

[cbartz]

@arturo-seijas

I think the jobs per application metric would be better displayed as a bar chart. The current chart doesn't seem to intuitive to me

The problem with bar charts is that the focus is on the graph and not on the legend. The idea here is to present a list of available applications, so the focus should be on the text. My first version was as follows:

[arturo-seijas]

@arturo-seijas

I think the jobs per application metric would be better displayed as a bar chart. The current chart doesn't seem to intuitive to me

The problem with bar charts is that the focus is on the graph and not on the legend. The idea here is to present a list of available applications, so the focus should be on the text. My first version was as follows:

What about an horizontal bar chart, with the legend on the left side?

[cbartz]

What about an horizontal bar chart, with the legend on the left side?

@arturo-seijas This would look like

But as mentioned the emphasis would be a bit fewer on the application names.

There is also already a panel at the bottom of the dashboard that shows the application share and looks like this:

This could simply be reused and moved to the top to indicate the list of applications.

Perhaps @jdkandersson can give his opinion on this, as the new panel was requested by him.

[arturo-seijas]

What about an horizontal bar chart, with the legend on the left side?

@arturo-seijas This would look like

But as mentioned the emphasis would be a bit fewer on the application names.

There is also already a panel at the bottom of the dashboard that shows the application share and looks like this:

This could simply be reused and moved to the top to indicate the list of applications.

Perhaps @jdkandersson can give his opinion on this, as the new panel was requested by him.

When I see the application share I find too difficult to see the values for those that are not at the top nor bottom. In the screenshot above, what are the values for large? Again, I think bar charts are in order here, something like this

[cbartz]

When I see the application share I find too difficult to see the values for those that are not at the top nor bottom. In the screenshot above, what are the values for large? Again, I think bar charts are in order here, something like this

@arturo-seijas Ok, gotcha. I'm fine with using bar charts, but I think I need to re-confirm that this meets the acceptance criteria, as the original story was just to visualise the names of applications, not the number of jobs or anything. I just added it because the log panel only showing the names didn't look "pretty" to me. See also the jira ticket.

[varshigupta12]

@cbartz I am wondering if all we need is an easy way for users to search by application- can we change the Flavors textbox to be a dropdown instead? Something like-

[cbartz]

@cbartz I am wondering if all we need is an easy way for users to search by application- can we change the Flavors textbox to be a dropdown instead? Something like-

@varshigupta12 The text box is automatically generated by Grafana and is not intended for further customisation. There are drop-down menus for "Query variables", but unfortunately these are not applicable here because the "flavor" is not a real label. It might be possible to turn it into a real label, which might require some customisation of the grafana-agent charm. I think we (@jdkandersson and I) decided not to put too much effort into solving this problem, but it could certainly be investigated together with the observability team.

[jdkandersson]

@cbartz I am wondering if all we need is an easy way for users to search by application- can we change the Flavors textbox to be a dropdown instead? Something like-

@varshigupta12 The text box is automatically generated by Grafana and is not intended for further customisation. There are drop-down menus for "Query variables", but unfortunately these are not applicable here because the "flavor" is not a real label. It might be possible to turn it into a real label, which might require some customisation of the grafana-agent charm. I think we (@jdkandersson and I) decided not to put too much effort into solving this problem, but it could certainly be investigated together with the observability team.

Yeh we couldn't find a way to do a drop down and this is the alternative.

Perhaps we do the horizontal bar chart and make the number the number of available runners? I think that would be a useful chart anyway

[cbartz]

@jdkandersson Can you please review? Thanks.

[github-actions]

Test coverage for aeebd7b

Name                                       Stmts   Miss Branch BrPart  Cover   Missing
--------------------------------------------------------------------------------------
src/charm.py                                 462     88    105     22    78%   113-114, 116-117, 122-123, 209-211, 264-283, 301-303, 304->308, 334-338, 422-451, 487-492, 509, 530, 542-548, 562-563, 576, 608-609, 612->617, 651, 655-660, 696, 705->708, 726-727, 759-772, 801-806, 820, 867-868, 870-871, 873-874, 948->950, 1015-1016, 1054-1056, 1073
src/charm_state.py                           346      0     76      0   100%
src/errors.py                                 41      0      0      0   100%
src/event_timer.py                            54      7      2      1    86%   105-106, 131, 148-149, 165-166
src/firewall.py                               51     18     20      0    61%   42-43, 66-69, 111-185
src/github_client.py                          95     16     40      5    79%   65-72, 119->exit, 124-125, 195, 218, 231-238, 260->295, 289
src/github_metrics.py                         13      0      0      0   100%
src/github_type.py                            49      0      0      0   100%
src/lxd_type.py                               35      0      2      0   100%
src/metrics.py                                75      2     10      1    96%   62->65, 172-173
src/metrics_type.py                            5      0      0      0   100%
src/openstack_cloud/__init__.py               26      0      2      0   100%
src/openstack_cloud/openstack_manager.py     126     16     26      1    86%   108, 376-379, 427, 456-482
src/runner.py                                335     74     96     24    73%   46->48, 192->206, 264-265, 291-292, 336-345, 369-374, 379, 403, 407-417, 466->469, 472-474, 481, 495, 510, 514, 516, 533, 567-572, 591-604, 616-655, 664, 707, 716-717, 764-766, 770, 791, 830, 858, 863-875, 893, 898->900, 903-905
src/runner_logs.py                            34      2      6      1    92%   62->61, 66-67
src/runner_manager.py                        320     59    108     13    81%   127, 172-174, 187-188, 200-202, 208-213, 217-218, 253, 296-297, 341-343, 417, 427, 456, 467-471, 496, 519-522, 588-606, 623-628, 652-654, 672-673, 786, 808-810
src/runner_manager_type.py                    38      0      6      0   100%
src/runner_metrics.py                        121      5     18      0    96%   215-216, 331-335
src/runner_type.py                            31      0      8      0   100%
src/shared_fs.py                             125     18     20      0    88%   106-107, 131-132, 215-216, 246-247, 259-260, 286-287, 293-294, 318-319, 326-327
src/utilities.py                              67      7     20      7    82%   85->87, 89->95, 102, 132, 146, 185-188, 243
--------------------------------------------------------------------------------------
TOTAL                                       2449    312    565     75    85%

Static code analysis report

Run started:2024-05-28 07:53:50.356924

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 5839
  Total lines skipped (#nosec): 1
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 7

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):