Send grafana link with dashboard data #85

sjd78 · 2022-02-17T01:12:29Z

To be able to display a link to the Montioring Portal on the
dashboard on ovirt-engine-ui-extensions, the link needs to be
passed along with the rest of the dashboard info. If grafana is
not configured on the engine, null is returned.

Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=1991482

If the URL for the engine's grafana instance is available from the `database_data` fetch, render the link in the upper right hand side of the dashboard. This allows the user to click directly to the monitoring portal without jumping back to the welcome page first. Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=1991482 Require ovirt-engine PR: oVirt/ovirt-engine#85

If the URL for the engine's grafana instance is available from the `dashboard_data` fetch, render the link in the upper right hand side of the dashboard. This allows the user to click directly to the monitoring portal without jumping back to the welcome page first. If no URL is provided from the `dashboard_data` fetch, no link is rendered. Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=1991482 Require ovirt-engine PR: oVirt/ovirt-engine#85

sjd78 · 2022-02-17T01:30:52Z

This PR is a requirement for oVirt/ovirt-engine-ui-extensions#33.

If the URL for the engine's grafana instance is available from the `dashboard_data` fetch, render the link in the upper right hand side of the dashboard. This allows the user to click directly to the monitoring portal without jumping back to the welcome page first. If no URL is provided from the `dashboard_data` fetch, no link is rendered. Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=1991482 Require ovirt-engine PR: oVirt/ovirt-engine#85

...ontend/src/main/java/org/ovirt/engine/ui/frontend/server/dashboard/DashboardDataServlet.java

sjd78 · 2022-02-23T19:19:13Z

The URL lookup now only considers the URL config key and does not report any error if it is missing. Reporting error like this to the server log duplicates what is done in the BrandingManager.

sgratch

The URL lookup now only considers the URL config key and does not report any error if it is missing. Reporting error like this to the server log duplicates what is done in the BrandingManager.

There is one problem with that approach of avoid validating the conf file:
If the 10-setup-grafana-access.conf file doesn't include the ENGINE_GRAFANA_FQDN parameter for some reason or the parameter exists but no value is set, then branding will raise an error and "Monitoring Portal" entry won't be added to welcome page, but it will be added to oVirt dashboard and point to https:///ovirt-engine-grafana/ which is always a wrong url.

Maybe worth just checking that those 2 parameters are set to something.

sjd78 · 2022-02-28T18:20:22Z

The URL lookup now only considers the URL config key and does not report any error if it is missing. Reporting error like this to the server log duplicates what is done in the BrandingManager.

There is one problem with that approach of avoid validating the conf file: If the 10-setup-grafana-access.conf file doesn't include the ENGINE_GRAFANA_FQDN parameter for some reason or the parameter exists but no value is set, then branding will raise an error and "Monitoring Portal" entry won't be added to welcome page, but it will be added to oVirt dashboard and point to https:///ovirt-engine-grafana/ which is always a wrong url.

Maybe worth just checking that those 2 parameters are set to something.

The code now checks to make sure both of the grafana keys are not blank before returning the URL.

If the URL for the engine's grafana instance is available from the `dashboard_data` fetch, render the link in the upper right hand side of the dashboard. This allows the user to click directly to the monitoring portal without jumping back to the welcome page first. If no URL is provided from the `dashboard_data` fetch, no link is rendered. Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=1991482 Require ovirt-engine PR: oVirt/ovirt-engine#85

sgratch

Please see my comment.

...ontend/src/main/java/org/ovirt/engine/ui/frontend/server/dashboard/DashboardDataServlet.java

If the URL for the engine's grafana instance is available from the `dashboard_data` fetch, render the link in the upper right hand side of the dashboard. This allows the user to click directly to the monitoring portal without jumping back to the welcome page first. If no URL is provided from the `dashboard_data` fetch, no link is rendered. Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=1991482 Require ovirt-engine PR: oVirt/ovirt-engine#85

mwperina · 2022-03-04T07:43:09Z

@avlitman We are passing engine FQDN into remote DWH installation, but do we have some where engine stored the information about remote DWH FQDN so we can provide a link to remote Grafana installation in webadmin dashboard?

avlitman · 2022-03-04T10:20:18Z

@avlitman We are passing engine FQDN into remote DWH installation, but do we have some where engine stored the information about remote DWH FQDN so we can provide a link to remote Grafana installation in webadmin dashboard?

Hi, yes we are passing engine FQDN into DWH in all cases (remote or local).
I can't find any column in the engine db that points to remote/local DWH FQDN,
as mention above when configuring Grafana (now it's by default) the engine have a file: /etc/ovirt-engine/engine.conf.d/10-setup-grafana-access.conf that includes 2 parameters ENGINE_GRAFANA_FQDN, and ENGINE_GRAFANA_BASE_URL
If dwh is local: ENGINE_GRAFANA_FQDN=engine_fqdn
If dwh is remote: ENGINE_GRAFANA_FQDN=dwh_fqdn

To sum it up I think the best way is to use those 2 parameters, and as Sharon said check that those 2 parameters are set to something.

avlitman · 2022-03-04T10:32:59Z

I'm wondering if we can set the monitoring portal link to be on all pages in the admin portal,
like the Toolbar:

I think it will make great impact for the customers to be able to navigate to the monitoring portal easily from any page in the admin portal.

@sgratch @sjd78 Do you think it's a possibility ?

sjd78 · 2022-03-04T14:10:45Z

I'm wondering if we can set the monitoring portal link to be on all pages in the admin portal, like the Toolbar: I think it will make great impact for the customers to be able to navigate to the monitoring portal easily from any page in the admin portal.

@sgratch @sjd78 Do you think it's a possibility ?

It can be done, but that isn't what was asked for in the BZ. This change specifically enables the link to be displayed on the dashboard (which is over in ovirt-engine-ui-extensions). I'm willing to add that in another PR, but I'm not sure I'll have time for it before feature freeze.

To be able to display a link to the Montioring Portal on the dashboard on `ovirt-engine-ui-extensions`, the link needs to be passed along with the rest of the dashboard info. If grafana is not configured on the engine, `null` is returned. Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=1991482

avlitman · 2022-03-07T11:15:11Z

I'm wondering if we can set the monitoring portal link to be on all pages in the admin portal, like the Toolbar: I think it will make great impact for the customers to be able to navigate to the monitoring portal easily from any page in the admin portal.
@sgratch @sjd78 Do you think it's a possibility ?

It can be done, but that isn't what was asked for in the BZ. This change specifically enables the link to be displayed on the dashboard (which is over in ovirt-engine-ui-extensions). I'm willing to add that in another PR, but I'm not sure I'll have time for it before feature freeze.

@sjd78 +1 Thank you, much appreciated! so should I open a second bug for that?

sgratch · 2022-03-07T11:25:10Z

@sjd78 +1 Thank you, much appreciated! so should I open a second bug for that?

@avlitman please do if you think it's valuable, but most sure we won't have time to handle that for 4.5 since there are more urgent stuff planned.

sgratch

LGTM

* Add link to Monitoring Portal on Dashboard If the URL for the engine's grafana instance is available from the `dashboard_data` fetch, render the link in the upper right hand side of the dashboard. This allows the user to click directly to the monitoring portal without jumping back to the welcome page first. If no URL is provided from the `dashboard_data` fetch, no link is rendered. Bug-Url: https://bugzilla.redhat.com/show_bug.cgi?id=1991482 Require ovirt-engine PR: oVirt/ovirt-engine#85 * remove unused styles * adjust monitoring link styles to PF4 CSS vars

sjd78 requested review from sgratch and ljelinkova as code owners February 17, 2022 01:12

sjd78 requested a review from rszwajko February 17, 2022 01:13

sjd78 mentioned this pull request Feb 17, 2022

Add link to Monitoring Portal on Dashboard oVirt/ovirt-engine-ui-extensions#33

Merged

rszwajko reviewed Feb 17, 2022

View reviewed changes

...ontend/src/main/java/org/ovirt/engine/ui/frontend/server/dashboard/DashboardDataServlet.java Outdated Show resolved Hide resolved

rszwajko approved these changes Feb 17, 2022

View reviewed changes

...ontend/src/main/java/org/ovirt/engine/ui/frontend/server/dashboard/DashboardDataServlet.java Outdated Show resolved Hide resolved

sgratch added the UX label Feb 17, 2022

sgratch reviewed Feb 18, 2022

View reviewed changes

...ontend/src/main/java/org/ovirt/engine/ui/frontend/server/dashboard/DashboardDataServlet.java Outdated Show resolved Hide resolved

sjd78 force-pushed the dashboard_grafana branch from c465563 to d706144 Compare February 23, 2022 19:16

sjd78 requested review from rszwajko and sgratch February 23, 2022 19:17

sgratch reviewed Feb 28, 2022

View reviewed changes

sjd78 force-pushed the dashboard_grafana branch from d706144 to 92d12a7 Compare February 28, 2022 18:19

sjd78 requested a review from sgratch February 28, 2022 18:21

sgratch requested changes Mar 1, 2022

View reviewed changes

...ontend/src/main/java/org/ovirt/engine/ui/frontend/server/dashboard/DashboardDataServlet.java Outdated Show resolved Hide resolved

sjd78 force-pushed the dashboard_grafana branch from 92d12a7 to 51a8049 Compare March 2, 2022 17:53

sjd78 requested a review from sgratch March 2, 2022 17:53

sgratch force-pushed the dashboard_grafana branch from 51a8049 to b7e16ef Compare March 3, 2022 19:39

mwperina requested a review from avlitman March 4, 2022 07:40

sjd78 force-pushed the dashboard_grafana branch from b7e16ef to 4d7890b Compare March 4, 2022 14:14

sgratch force-pushed the dashboard_grafana branch from 4d7890b to e64377b Compare March 7, 2022 10:59

sgratch approved these changes Mar 7, 2022

View reviewed changes

sgratch merged commit 43cc067 into oVirt:master Mar 7, 2022

sjd78 deleted the dashboard_grafana branch March 17, 2022 14:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Send grafana link with dashboard data #85

Send grafana link with dashboard data #85

sjd78 commented Feb 17, 2022

sjd78 commented Feb 17, 2022

sjd78 commented Feb 23, 2022

sgratch left a comment

sjd78 commented Feb 28, 2022

sgratch left a comment

mwperina commented Mar 4, 2022

avlitman commented Mar 4, 2022 •

edited

avlitman commented Mar 4, 2022

sjd78 commented Mar 4, 2022 •

edited

avlitman commented Mar 7, 2022

sgratch commented Mar 7, 2022

sgratch left a comment

Send grafana link with dashboard data #85

Send grafana link with dashboard data #85

Conversation

sjd78 commented Feb 17, 2022

sjd78 commented Feb 17, 2022

sjd78 commented Feb 23, 2022

sgratch left a comment

Choose a reason for hiding this comment

sjd78 commented Feb 28, 2022

sgratch left a comment

Choose a reason for hiding this comment

mwperina commented Mar 4, 2022

avlitman commented Mar 4, 2022 • edited

avlitman commented Mar 4, 2022

sjd78 commented Mar 4, 2022 • edited

avlitman commented Mar 7, 2022

sgratch commented Mar 7, 2022

sgratch left a comment

Choose a reason for hiding this comment

avlitman commented Mar 4, 2022 •

edited

sjd78 commented Mar 4, 2022 •

edited