diff --git a/guides/_subsections/configure-feature-level.md b/guides/_subsections/configure-feature-level.md new file mode 100644 index 00000000..8b6cbf28 --- /dev/null +++ b/guides/_subsections/configure-feature-level.md @@ -0,0 +1,19 @@ +### [Configure Feature Level](#configure-feature-level) +Some features in the **web-client** UI are *Beta*-level features. This indicates that they are still underdoing design and development, and may have significant limitations, or be redesigned or even removed in the future. + +For those reasons, *Beta* features are hidden by default in the **Cryostat** UI. They can be enabled by following the steps below. + +
    +
  1. + {% include_relative _subsections/common/navigate-to-settings.md %} +
  2. +
  3. + {% include howto_step.html + summary="Locate the Advanced settings" + image-name="4.0.0/advanced-setting.png" + text=" + The Advanced tab within this view contains a control to set the Feature Level of the UI. This is set to Production by default. You can enable additional features by setting this to Beta, with the aforementioned caveats in mind. Once this is set, a Beta badge will appear on the Cryostat application titlebar. Additional features enabled by this setting, such as Dashboard cards, will be labelled with a similar badge to indicate the feature level. If you set the feature level back to Production then any Beta-level features will be hidden from the UI again. + " + %} +
  4. +
diff --git a/guides/_subsections/navigate-the-dashboard.md b/guides/_subsections/navigate-the-dashboard.md index bcbdb5d7..6959a916 100644 --- a/guides/_subsections/navigate-the-dashboard.md +++ b/guides/_subsections/navigate-the-dashboard.md @@ -5,7 +5,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I ### [Dashboard Cards](#dashboard-cards) -`Dashboard cards` are widgets that display information about your **Cryostat** instance and the `target` **JVM** applications it is monitoring. Let's walk through the available `cards` and how to add them to your *Dashboard*. +`Dashboard cards` are widgets that display information about your **Cryostat** instance and the `target` **JVM** applications it is monitoring, or allow you to perform diagnostic actions against the `targets`. Let's walk through the available `cards` and how to add them to your *Dashboard*. {% include_relative _subsections/common/card-catalog.md %} @@ -214,7 +214,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I text=mbean-metrics-chart-text %} -
  • +
  • {% capture configure-mbean-metrics-chart %}

    In the next steps of the card creation, you can configure the details of the chart card. @@ -245,6 +245,115 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I

  • +#### [JFR Metrics Chart Card](#jfr-metrics-chart-card) + +
      +
    1. + {% capture jfr-metrics-chart-text %} +

      + The JFR Metrics Chart card displays performance metrics about the target JVM by visualizing JFR data snapshots via embedded Grafana visualization panels as Dashboard cards. This Beta-level feature. A significant limitation of this card is that it depends upon the stateful jfr-datasource backend component, which only converts one Flight Recording file at a time to Grafana data. Therefore, this card does not behave well if multiple web-client instances are open at the same time, whether used by one user or multiple human users. +

      +

      + Cryostat gathers typical JFR data from the selected Targetand periodically updates the Grafana visualizations. You can customize each card by going through the card creation wizard. The wizard will guide you through the process of selecting the metrics you want to display, how you want to display them, and other various configuration options. Some examples of Performance Metrics that can be displayed are: +

      + + {% endcapture %} + {% include howto_step.html + summary="Add the JFR Metrics Chart Card" + image-name="4.0.0/dashboard/jfrmetrics-preview.png" + caption="Click on the JFR Metrics Chart card. No preview is available." + text=jfr-metrics-chart-text + %} +
    2. +
    3. + {% capture jfr-mbean-metrics-chart %} +

      + In the next steps of the card creation, you can configure the details of the chart card. +

      +

      + Configure the metric data by clicking the Performance Metric dropdown and selecting a metric. You can also configure the Data Window to display a specific time range of data and the Refresh Period to control how often the chart is updated. +

      + {% endcapture %} + {% include howto_step.html + summary="Configure the JFR Metrics Chart Card" + image-name="4.0.0/dashboard/jfrmetrics-configuration.png" + caption="Click Next to provide card configuration." + text=jfr-mbean-metrics-chart + %} +
    4. +
    5. + {% capture jfr-metrics-chart-created %} +

      + After clicking Finish, the card will be added to the dashboard. Initially the card will have no source Recording and display no data. +

      + {% endcapture %} + {% include howto_step.html + summary="Finish Card Creation" + image-name="4.0.0/dashboard/jfrmetrics-no-source.png" + caption="The JFR Metrics Chart card created with no source recording." + text=jfr-metrics-chart-created + %} +
    6. +
    7. + {% capture jfr-metrics-chart-finish %} +

      + Click Create on the card to create a source Recording. Cryostat will walk you through creating the Recording. You can simply click through the form and accept the suggested default settings. This will begin a Flight Recording on the selected Target and send you to the Recordings view. Once you return to the Dashboard and the recording is available then Cryostat will begin to process and update the Recording to update the card visualization. +

      + {% endcapture %} + {% include howto_step.html + summary="Start source Flight Recording" + image-name="4.0.0/dashboard/jfrmetrics.png" + caption="The JFR Metrics Chart card displayed with the Memory Usage metric." + text=jfr-metrics-chart-finish + %} +
    8. +
    + +#### [Diagnostic Actions Card](#diagnostic-actions-card) + +
      +
    1. + {% capture diagnostics-card-text %} +

      + The Diagnostics card allows you to perform non-metrics diagnostic actions against the selected Target. This Beta-level feature +

      +

      + The following diagnostic actions are available: +

      +

      + {% endcapture %} + {% include howto_step.html + summary="Add the Diagnostics Card" + image-name="4.0.0/dashboard/diagnostics-preview.png" + caption="Click on the Diagnostics card. No preview is available." + text=diagnostics-card-text + %} +
    2. +
    3. + {% capture diagnostics-card-created %} +

      + After clicking Finish, the card will be added to the dashboard. +

      + {% endcapture %} + {% include howto_step.html + summary="Finish Card Creation" + image-name="4.0.0/dashboard/diagnostics.png" + caption="The Diagnostics card." + text=diagnostics-card-created + %} +
    4. +
    + ### [Configuring the Dashboard](#configuring-the-dashboard) The Dashboard is highly customizable and can be configured to display the cards you want to see. You can customize the layout of the cards on the dashboard by Moving, Resizing, and Removing cards. diff --git a/guides/index.md b/guides/index.md index b2843a48..d4c4eb71 100644 --- a/guides/index.md +++ b/guides/index.md @@ -11,6 +11,8 @@ common actions and workflows of interest and why they are useful. {% include_relative _subsections/getting-help.md %} +{% include_relative _subsections/configure-feature-level.md %} + {% include_relative _subsections/navigate-the-dashboard.md %} {% include_relative _subsections/use-topology-view.md %} diff --git a/images/4.0.0/advanced-setting.png b/images/4.0.0/advanced-setting.png new file mode 100644 index 00000000..2239b5e9 Binary files /dev/null and b/images/4.0.0/advanced-setting.png differ diff --git a/images/4.0.0/dashboard/diagnostics-preview.png b/images/4.0.0/dashboard/diagnostics-preview.png new file mode 100644 index 00000000..fb8cc99e Binary files /dev/null and b/images/4.0.0/dashboard/diagnostics-preview.png differ diff --git a/images/4.0.0/dashboard/diagnostics.png b/images/4.0.0/dashboard/diagnostics.png new file mode 100644 index 00000000..47416851 Binary files /dev/null and b/images/4.0.0/dashboard/diagnostics.png differ diff --git a/images/4.0.0/dashboard/jfrmetrics-configuration.png b/images/4.0.0/dashboard/jfrmetrics-configuration.png new file mode 100644 index 00000000..10d58081 Binary files /dev/null and b/images/4.0.0/dashboard/jfrmetrics-configuration.png differ diff --git a/images/4.0.0/dashboard/jfrmetrics-no-source.png b/images/4.0.0/dashboard/jfrmetrics-no-source.png new file mode 100644 index 00000000..87f9ffcb Binary files /dev/null and b/images/4.0.0/dashboard/jfrmetrics-no-source.png differ diff --git a/images/4.0.0/dashboard/jfrmetrics-preview.png b/images/4.0.0/dashboard/jfrmetrics-preview.png new file mode 100644 index 00000000..6a6d2a70 Binary files /dev/null and b/images/4.0.0/dashboard/jfrmetrics-preview.png differ diff --git a/images/4.0.0/dashboard/jfrmetrics.png b/images/4.0.0/dashboard/jfrmetrics.png new file mode 100644 index 00000000..86307959 Binary files /dev/null and b/images/4.0.0/dashboard/jfrmetrics.png differ