Uploaded image for project: 'OpenShift Console'
  1. OpenShift Console
  2. CONSOLE-3317

Dynamic Plugin Template for custom metrics dashboard


    • Dynamic Plugin Template for custom metrics dashboard
    • False
    • None
    • False
    • Not Selected
    • To Do
    • OCPSTRAT-402 - Unified Console
    • 75% To Do, 0% In Progress, 25% Done

      Epic Goal

      Why is this important?

      This is nice but requires a lot of effort on the customer to create such a plugin. It therefore would be nice to provide certain templates for such dynamic templates in order to help customers to get started. The templates could be for certain common use cases such as a page that allows viewing customer specific metric dashboards.

      Similar what is available in the OpenShift 4 - Console under Observe with the dashboards but the ability to specify queries based on customer specific metrics and then define the type of the graph.

      With the given template, it would be easier for customers to start adopting that functionality and continue building additional functionality if and where needed.


      Dynamic Plugins is great but requires some effort to get started if somebody is not super familiar with the SDK made available. Therefore providing templates for certain use cases would be helpful for customers and even partners to increase knowledge faster and get started with the dynamic plugin functionality.

      Currently there are three cases where the metrics are being displayed in the console:

      1. Standalone dashboard (e.g. Observe -> Dashboard)
      2. Simple Metrics dashboard tab (e.g. Pod Details > Metrics Dashboard)
      3. Highly customized dashboard (e.g. Home > Overview page)

      For each of them we should have an example in the Metrics Template.

      This document contains all the knowledge on the metrics use-cases and their requirements. 

      Visualising custom metrics is a common ask and therefore a potential good example to create such a template.

      Acceptance Criteria

      • CI - MUST be running successfully with tests automated
      • Release Technical Enablement - Provide necessary release enablement details and documents.
      • Add a graph component to the existing dynamic demo plugin that shows usage of the sdk

      Open questions::

      Done Checklist

      • CI - CI is running, tests are automated and merged.
      • Release Enablement <link to Feature Enablement Presentation>
      • DEV - Upstream code and tests merged: <link to meaningful PR or GitHub Issue>
      • DEV - Upstream documentation merged: <link to meaningful PR or GitHub Issue>
      • DEV - Downstream build attached to advisory: <link to errata>
      • QE - Test plans in Polarion: <link or reference to Polarion>
      • QE - Automated tests merged: <link or reference to automated tests>
      • DOC - Downstream documentation merged: <link to meaningful PR>

        Docs Tracker Sub-task Closed Undefined Unassigned
        QE Tracker Sub-task Closed Undefined Unassigned
        PX Tracker Sub-task Closed Undefined Rick Wagner
        TE Tracker Sub-task Closed Undefined Rick Wagner

            jhadvig@redhat.com Jakub Hadvig
            jcaiani@redhat.com Joseph Caiani
            Yanping Zhang Yanping Zhang
            Olivia Payne Olivia Payne
            0 Vote for this issue
            9 Start watching this issue