[FEATURE] Central View of the Release Metrics Dashboards

[prudhvigodithi]

Is your feature request related to a problem?

As part of #51 today we have multiple dashboards for release metrics. These dashboards include metrics that can be used by the release manager to drive the release, metrics for the community to track the current status of the release and metrics for the component level release owners and teams to track the build and integration test failures.

Dashboards for release manager and community to track the release: Dashboard Link.

Dashboards for Build and Integration Test failures: Dashboards Link.

What solution would you like?

Have a central view of all the release dashboards that are related to release. Having a central view will eliminate multiple clicks of moving around between dashboards and a user can have a central view for the release metrics.

Combining all release-related visualizations into a single dashboard is not a viable solution. Applying global filters at the dashboard level would affect all visualizations within it, which becomes problematic given the extensive data and multiple metrics involved. The data is organized into multiple indices, each with different key-value mappings. Since no two metric categories for releases are identical, consolidating them under a single dashboard is not a solution.

Example:
The Dashboards for Build and Integration Test failures: Dashboards Link has data about the integration test failures for an Release candidate, the filter applied for these Dashboard are related to build_number, platform, distribution, rc_number etc, whereas for Dashboards for release manager and community to track the release: Dashboard Link the filters used for the mentioned 1st dashboard does not apply as these visualizations targets different metrics like number of release_issues, release_owner assigned (yes/or) etc.

So the solution is:

Embed the dashboards Iframe URL to https://opensearch.org/ similar to what we have to https://opensearch.org/benchmarks. Add all the release dashboards Iframes to this https://opensearch.org/ page so that users can have all the release metrics under on view (in one page). The Iframe embeddings should have the following conditions met.

• Add a navigation page as https://opensearch.org/release-metrics.

• Make sure the Iframe for dashboards part of https://metrics.opensearch.org/_dashboards/app/home is only allowed for https://opensearch.org/, default have the X-Frame-Options: DENY. Related PR Support central of the metrics #70.

• Have a modal view (pop up open and close) in https://opensearch.org/release-metrics for a user to target view of the single dashboard. This is possible with <h1 onclick=</h1> with HTML.
  -

• Have an anchors at the beginning of the page for user to click and go to the target dashboard. This will reduce the scroll for the user and directly viewing the target dashboard. Possible with

<div class="nav-index">
    <a href="#metrics-dashboard">OpenSearch Release Metrics</a>
    <a href="#test-results-dashboard">OpenSearch Release Build and Integration Test Results</a>
</div>

The anchor URL's:
* https://opensearch.org/release-metrics#metrics-dashboard
* https://opensearch.org/release-metrics#test-results-dashboard

• Along with the dashboards and pop ups have the original dashboard link (https://metrics.opensearch.org/) added to the page so that user can directly go to the main dashboard part of metrics URL.
  

• Ability for the user to filter the data and visualizations directly from https://opensearch.org/release-metrics. Having this the user should be to get the right data directly under the same view https://opensearch.org/release-metrics. Need not go to https://metrics.opensearch.org/ and click the dashboards again for filtering the data. The idea is not just the single view but also should be able to query the data from https://opensearch.org/release-metrics.
  

• The https://opensearch.org/release-metrics should have the share dashboard link of https://metrics.opensearch.org/. Example user added release version query on a dashboard part of https://opensearch.org/release-metrics, now user should have the share button enabled that can copy the directl URL of https://metrics.opensearch.org/ and share it as required. This will allow users to directly add filters to the dashboards and get the exact sharable URL of https://metrics.opensearch.org/ from https://opensearch.org/release-metrics.
  

Do you have any additional context?

For the goals to achieve need to make some changes in https://github.com/opensearch-project/project-website/.

• Related PR Central view of the release metrics in the website. project-website#3254.

[prudhvigodithi]

Adding @getsaurabh02 @dblock @bshien

[getsaurabh02]

Thanks @prudhvigodithi, are there any mocks you would want to share as well?

[prudhvigodithi]

Sure Let me share some sample mocks here. Thanks

[prudhvigodithi]

Coming from the above requirement:

Make sure the Iframe for dashboards part of https://metrics.opensearch.org/_dashboards/app/home is only allowed for https://opensearch.org/, default have the X-Frame-Options: DENY.

We can use the following to ensure the Iframe is only allowed for https://opensearch.org, we cam update opensearchNginxProxyReadonly.ts accordingly.

add_header X-Frame-Options "DENY";  
add_header Content-Security-Policy "frame-ancestors https://opensearch.org";

[prudhvigodithi]

Hey I havent seen any mock framework added to the project-website, hence captured a small video on the behaviour based on the issue description. @getsaurabh02 @dblock to please take a look.

release-metrics-ui-mock.1.mov

[prudhvigodithi]

The following improvements are added:

• Updated the anchor links of the dashboards and added as part of the <p> body.
• Added new dashboard OpenSearch Component Release Metrics, using https://metrics.opensearch.org/_dashboards/app/dashboards#/view/be62b350-6b06-11ef-8d6b-d50babf51bc6.
• Added release_versions array with version, release_issue and release_retro_issue. This central view should now support multiple releases. There are times we end up doing multiple versions in parallel.
• Added UI enhancement for the user to choose the release version.
  • Default will be the latest and the current release version selected and version.keyword is applied across the dashboards and to the visualizations.
  • User can unselect this and the UI will now have dashboards with version.keyword not selected.
  • The user can choose different release version other than the default selected (the oner other than the current on going release) and the version.keyword is applied across the dashboards and to the visualizations.
• The modal pop up's and the directly dashboard links are also updated based on version selected by the user.
• The URL will be changed from https://opensearch.org/release-metrics to https://opensearch.org/release-dashboard.

Here is the mock video with the above changes.

central-release-ui.1.mov

Thank you
@getsaurabh02

[prudhvigodithi]

The central view of the release dashboard is now part of the OpenSearch website https://opensearch.org/release-dashboard. Closing this issue.
Thanks