[Task] Redesign Grafana Dashboard

[tthvo]

The Grafana Dashboard has't been updated and needs redesigning to support new events. Here are some of the things to look into:

• [x] Categorize panels according to events. This will be easier for extension.
• [x] Fix unit display.
• [x] Larger default time frame.
• [x] Rename dashboard to Cryostat or probably the recording name #2
• [x] Clean up unused fields (i.e. hashKey generated by Grafana)
• [x] Support separate dashboard with filters for jdk.ObjectAllocationSample
• [x] Each "sub" dashboard should have direct link back to the Main Dashboard.
• [x] Dashboard should default to open main Cryostat Dashboard on launch.

Datasource task:

• [x] https://github.com/cryostatio/jfr-datasource/issues/128
• [x] https://github.com/cryostatio/jfr-datasource/issues/62
• [x] https://github.com/cryostatio/jfr-datasource/issues/129
• [x] https://github.com/cryostatio/jfr-datasource/issues/130
• [x] https://github.com/cryostatio/jfr-datasource/issues/78
• [x] https://github.com/cryostatio/jfr-datasource/issues/134

[tthvo]

Here is my latest design:

Grafana image: quay.io/thvo/cryostat-grafana-dashboard:redesign

Source: Dashboard.json.txt

I could not include a screenshot since the Dashboard does not fit into a single screen. Category might not be entirely accurate. Any thoughts on this @andrewazores?

[andrewazores]

The layout looks nice, I like it. The different categories are a good idea to make this more extensible in the future.

Should I still be able to see data on this new layout right now? I tried it out with a sample recording and everything is empty.

[tthvo]

Great! I will go on to the filter issues. And yes, I think so! It showed on my end. Not sure why not there?

Editted: I think you might need to change the time frame as some recordings are older. Maybe this helps?

[andrewazores]

Oh, yea, the timeframe was just way out of whack. Wonder why that is? I had to click the "zoom out" button several times to get the data within visible range and then zoom back in on it.

[andrewazores]

recording.zip

Here's a sample recording and what the dashboard looks like when it's loaded. Looks great! Though I can't help but notice that my physical memory usage is ~23 PETAbytes :D

[tthvo]

Oh, yea, the timeframe was just way out of whack. Wonder why that is? I had to click the "zoom out" button several times to get the data within visible range and then zoom back in on it.

Right I think it was my setup in the dashboard that set the overall time to:

  "time": {
    "from": "2022-09-21T18:32:04.907Z",
    "to": "2022-09-21T19:07:14.062Z"
  },

I should remove this when done tho :D

Here's a sample recording and what the dashboard looks like when it's loaded. Looks great! Though I can't help but notice that my physical memory usage is ~23 PETAbytes :D

Right! I think we have not checked unit conversion in datasource. Not sure if the library converts all to bytes but my guess now is probably not, seeing this. Related to https://github.com/cryostatio/jfr-datasource/issues/129

[tthvo]

See original comments: https://github.com/cryostatio/jfr-datasource/issues/62#issuecomment-1255409007

Current look for overall panel for Object.AllocationSample event:

A Dashboard for Object.AllocationSample event (screen-cast): Editted: somehow screencast broke at the time of the dynamically created panels. What happened is panel with selected filter is hidden and shown accordingly.

Screencast from 09-23-2022 07:09:40 AM.webm

[tthvo]

I still need to correct the units and add link in original full panel to this new more granular dashboard. Seems like adding a link on panel requires url, which fortunately allows omitting host:port parts. Though, the path seems auto-generated. Maybe, we could preconfigure the path somehow. What do you think?

[andrewazores]

This is awesome work. Really makes our Grafana dashboard so much more valuable.

The dashboard in the screencast is implemented as an entirely separate dashbard from the main/original one, and you're talking about adding a link from the main one to the Object.AllocationSample one, right? Does that link need to be an absolute URL or can it be simply a relative URL to the other dashboard's name? If it must be absolute, is it possible to reference an environment variable or system property within the URL string?

[andrewazores]

Oh, by "omitting host:port parts" I think you mean a relative URL is OK, right? As in no scheme://user@host:port is needed, the link can be just /some/path?query#fragment?

[andrewazores]

https://grafana.com/docs/grafana/latest/administration/provisioning/#reusable-dashboard-urls

https://github.com/cryostatio/cryostat-grafana-dashboard/blob/a2b63e81332b0877bd08cbf713f2a738534a08a6/dashboard.json#L1801

I think what this is saying is that if we just set this uid property on the dashboard definitions then the path to them is statically known, not randomly generated by the instance. Then we can just assume a relative URL between the two dashboards.

[tthvo]

https://grafana.com/docs/grafana/latest/administration/provisioning/#reusable-dashboard-urls

https://github.com/cryostatio/cryostat-grafana-dashboard/blob/a2b63e81332b0877bd08cbf713f2a738534a08a6/dashboard.json#L1801

I think what this is saying is that if we just set this uid property on the dashboard definitions then the path to them is statically known, not randomly generated by the instance. Then we can just assume a relative URL between the two dashboards.

Ah niceee! Then, that makes sense! Then the process should be much simpler. Thanks for explaining this. I will finish some final touches.