memory usage, CPU utilization, etc. Metadata Labels to the Create Recording form"
- image-name="4.1.0/add-and-edit-recording-metadata-labels-1.png"
+ image-name="4.2.0/add-and-edit-recording-metadata-labels-1.png"
text="
When creating a custom Flight Recording with Cryostat, expand the form section Show metadata options. Click Add Label and add key-Value Label pairs to the form. Finally, click Create to attach the Labels and create the Recording.
"
@@ -20,7 +20,7 @@ Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` ma
Labels on the Active Recordings Table"
- image-name="4.1.0/add-and-edit-recording-metadata-labels-2.png"
+ image-name="4.2.0/add-and-edit-recording-metadata-labels-2.png"
text="
The new Recording will appear in the Recordings Tab with your Custom Label as well as default Labels containing information about the selected Recording template.
"
@@ -34,14 +34,14 @@ Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` ma
{% endcapture %}
{% include howto_step.html
summary="Edit an Existing Label"
- image-name="4.1.0/add-and-edit-recording-metadata-labels-3.png"
+ image-name="4.2.0/add-and-edit-recording-metadata-labels-3.png"
text=edit-an-existing-label-text
%}
Labels"
- image-name="4.1.0/add-and-edit-recording-metadata-labels-4.png"
+ image-name="4.2.0/add-and-edit-recording-metadata-labels-4.png"
text="
The Recording Labels should be updated in the Active Recordings table.
"
@@ -50,7 +50,7 @@ Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` ma
Recording to view Labels copied onto the Archived Recording"
- image-name="4.1.0/add-and-edit-recording-metadata-labels-5.png"
+ image-name="4.2.0/add-and-edit-recording-metadata-labels-5.png"
text="
On the Active Recordings table, click the Checkbox next to the Recording, then click Archive to archive your Recording. Notice that the Archived Recording also copies the Labels from the Active Recording. You can also add Labels to any Recording uploaded to Cryostat’s archives.
"
@@ -61,8 +61,8 @@ Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` ma
Create another Recording on the same target. Then select both Recordings on the Recordings Table and click Edit Labels and start editing. This time, only Labels that are present on both Recordings will be shown in the form. Let's Delete the two common template-related Labels, and Add a new Label to both Recordings. Then finally, click Save.
-
- 
+
+ 
Congratulations, you have successfully bulk-edited Labels across multiple Recordings!
@@ -70,7 +70,7 @@ Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` ma
{% endcapture %}
{% include howto_step.html
summary="(Optional) Bulk-edit Recording Labels across multiple Recordings"
- image-name="4.1.0/add-and-edit-recording-metadata-labels-6.png"
+ image-name="4.2.0/add-and-edit-recording-metadata-labels-6.png"
text=bulk-edit-recording-labels-text
%}
-
+
-
+
+ The Visualize Thread Dumps page + allows you to visualize captured thread dumps from a
+targetJVM, looking for common problems + and analyzing for deadlocks. Thread Dumps can be analyzed from the archives or selected from a dropdown. +
+ -
+ {% include howto_step.html
+ summary="Select a Thread Dump"
+ image-name="4.2.0/analyze-a-thread-dump-1.png"
+ caption="
+ The dropdown menu will be populated with Thread Dumps from the archives for the currently selected target. If there are no
Thread Dumpsto source data from, capture one then return back to this view. For more information on capturing Thread Dumps, see Capture a Thread Dump. + " + %} +
+ - + {% include howto_step.html + summary="Request analysis" + image-name="4.2.0/analyze-a-thread-dump-2.png" + caption=" + Click the analysis process button in the corner of the drawer panel. + " + %} + +
- + {% include howto_step.html + summary="View aggregated data" + image-name="4.2.0/analyze-a-thread-dump-3.png" + caption=" + Once a thread dump has been selected the view will be populated with the analyzed data. There are pie charts displaying aggregation by thread state, running methods, and lock instances. + " + %} + +
- + {% include howto_step.html + summary="View detailed thread information" + image-name="4.2.0/analyze-a-thread-dump-4.png" + caption=" + Once a thread dump has been selected the view will be populated with the analyzed data. There is as a table for specific patterns found in the data, and deadlocks detected as well as detailed thread information. The specific findings looks for patterns in the captured thread dump that indicate common problems, for instance concurrency issues with logging. The deadlock detection table displays threads that are deadlocked as well as the objects that they are waiting for. The rows can be expanded to show the stack trace of the deadlocked thread and any locks held by that thread. The thread information table shows detailed thread information including the thread’s ID and native ID, priority, state, whether it is a daemon thread, and the CPU time used. Rows can similarly be expanded to view the stack trace and lock instances held by the thread. + " + %} + +
Analyze toolbar button"
- image-name="4.1.0/automated-analysis-1.png"
+ image-name="4.2.0/automated-analysis-1.png"
caption="
The analysis drawer will appear from the side. If Cryostat has already analyzed recording data from
this target recently then content will appear in the drawer. If there are no Active Recordings
@@ -31,7 +31,7 @@ Read the section on the [`Automated Analysis Card`](#automated-analysis-card) fo
{% include howto_step.html
summary="View analysis of an archived recording"
- image-name="4.1.0/automated-analysis-4.png"
+ image-name="4.2.0/automated-analysis-4.png"
caption="
Automated analysis results for individual Archived Recordings are also available.
"
diff --git a/guides/_subsections/capture-a-heap-dump.md b/guides/_subsections/capture-a-heap-dump.md
index 9e56dd54..786d891c 100644
--- a/guides/_subsections/capture-a-heap-dump.md
+++ b/guides/_subsections/capture-a-heap-dump.md
@@ -18,7 +18,7 @@
{% endcapture %}
{% include howto_step.html
summary="Navigate to the Diagnostics/Capture Page"
- image-name="4.1.0/capture-diagnostics-page.png"
+ image-name="4.2.0/capture-diagnostics-page.png"
caption="Click on Diagnostics/Capture on the sidebar."
text=capture-a-heap-dump-text
%}
@@ -29,7 +29,7 @@
Heap Dump has been archived, a new entry will appear in the
target JVM's Heap Dumps table. All Heap Dumps that were
diff --git a/guides/_subsections/capture-a-thread-dump.md b/guides/_subsections/capture-a-thread-dump.md
index dc811823..673529b0 100644
--- a/guides/_subsections/capture-a-thread-dump.md
+++ b/guides/_subsections/capture-a-thread-dump.md
@@ -18,7 +18,7 @@
{% endcapture %}
{% include howto_step.html
summary="Navigate to the Diagnostics/Capture Page"
- image-name="4.1.0/capture-diagnostics-page.png"
+ image-name="4.2.0/capture-diagnostics-page.png"
caption="Click on Diagnostics/Capture on the sidebar."
text=capture-a-thread-dump-text
%}
@@ -28,8 +28,8 @@
Thread Dump has been archived, a new entry will appear in the
target JVM's Thread Dumps table. All Thread Dumps that were
diff --git a/guides/_subsections/common/card-catalog.md b/guides/_subsections/common/card-catalog.md
index 23d7b165..88e23c19 100644
--- a/guides/_subsections/common/card-catalog.md
+++ b/guides/_subsections/common/card-catalog.md
@@ -3,7 +3,7 @@
{% endcapture %}
{% include howto_step.html
summary="Open the Card Catalog"
- image-name="4.1.0/dashboard/card-catalog.png"
+ image-name="4.2.0/dashboard/card-catalog.png"
caption="Open the Card Catalog by clicking the Catalog icon on the Dashboard toolbar."
text=card-catalog-include-text
%}
diff --git a/guides/_subsections/common/click-create.md b/guides/_subsections/common/click-create.md
index 0bb4c7f5..86810739 100644
--- a/guides/_subsections/common/click-create.md
+++ b/guides/_subsections/common/click-create.md
@@ -1,4 +1,4 @@
{% include howto_step.html
summary="Click Create"
- image-name="4.1.0/click-create.png"
+ image-name="4.2.0/click-create.png"
%}
diff --git a/guides/_subsections/common/layout-selector.md b/guides/_subsections/common/layout-selector.md
index bb3b4d2d..d5080e68 100644
--- a/guides/_subsections/common/layout-selector.md
+++ b/guides/_subsections/common/layout-selector.md
@@ -3,7 +3,7 @@ The Layout Selector contains a list of all available layouts. The current
{% endcapture %}
{% include howto_step.html
summary="Open the Layout Selector Dropdown"
-image-name="4.1.0/dashboard/dashboard-layoutselector.png"
+image-name="4.2.0/dashboard/dashboard-layoutselector.png"
caption="Click the layout selector dropdown to view the available layouts."
text=layout-selector-text
%}
diff --git a/guides/_subsections/common/navigate-to-dashboard.md b/guides/_subsections/common/navigate-to-dashboard.md
index 0de6d0f3..794ae82c 100644
--- a/guides/_subsections/common/navigate-to-dashboard.md
+++ b/guides/_subsections/common/navigate-to-dashboard.md
@@ -3,7 +3,7 @@
{% endcapture %}
{% include howto_step.html
summary="Navigate to Overview/Dashboard"
- image-name="4.1.0/navigate-to-dashboard.png"
+ image-name="4.2.0/navigate-to-dashboard.png"
caption="Add dashboard cards, switch between dashboard layouts, and modify the layout configuration to suit your needs."
text=navigate-to-dashboard-include-text
%}
diff --git a/guides/_subsections/common/navigate-to-recordings.md b/guides/_subsections/common/navigate-to-recordings.md
index b88c63e1..e1eb735c 100644
--- a/guides/_subsections/common/navigate-to-recordings.md
+++ b/guides/_subsections/common/navigate-to-recordings.md
@@ -3,14 +3,14 @@
necessary to add the target's certificate to Cryostat's trust store. Go
to Add a Trusted Certificate
and return to this section after completing that guide.
-
- 
+
+ 
{{ include.additional-content }}
{% endcapture %}
{% include howto_step.html
summary="Navigate to Flight Recorder/Capture/Recordings"
- image-name="4.1.0/navigate-to-recordings-1.png"
+ image-name="4.2.0/navigate-to-recordings-1.png"
caption="
Supply JMX credentials to authenticate to the target, if necessary. If
the target is not configured with JMX authentication then the
diff --git a/guides/_subsections/common/navigate-to-settings.md b/guides/_subsections/common/navigate-to-settings.md
index 691ec604..ec845aa0 100644
--- a/guides/_subsections/common/navigate-to-settings.md
+++ b/guides/_subsections/common/navigate-to-settings.md
@@ -6,7 +6,7 @@
{% endcapture %}
{% include howto_step.html
summary="Navigate to Settings"
- image-name="4.1.0/navigate-to-settings.png"
+ image-name="4.2.0/navigate-to-settings.png"
caption="
Click the cog or gear icon in the application masthead to access the Settings view.
"
diff --git a/guides/_subsections/common/navigate-to-topology.md b/guides/_subsections/common/navigate-to-topology.md
index 92149524..501426a5 100644
--- a/guides/_subsections/common/navigate-to-topology.md
+++ b/guides/_subsections/common/navigate-to-topology.md
@@ -3,7 +3,7 @@
{% endcapture %}
{% include howto_step.html
summary="Navigate to Overview/Topology"
- image-name="4.1.0/navigate-to-topology.png"
+ image-name="4.2.0/navigate-to-topology.png"
caption="Use the bottom Control Bar to adjust the Graph View as needed."
text=navigate-to-topology-include-text
%}
diff --git a/guides/_subsections/common/select-a-recording.md b/guides/_subsections/common/select-a-recording.md
index f0eaca84..110b8fe4 100644
--- a/guides/_subsections/common/select-a-recording.md
+++ b/guides/_subsections/common/select-a-recording.md
@@ -6,7 +6,7 @@
{% endcapture %}
{% include howto_step.html
summary="Select a Recording"
- image-name="4.1.0/select-a-recording.png"
+ image-name="4.2.0/select-a-recording.png"
caption=caption-content
text=text-content
%}
diff --git a/guides/_subsections/common/select-target-application.md b/guides/_subsections/common/select-target-application.md
index b2851638..7bdb86d3 100644
--- a/guides/_subsections/common/select-target-application.md
+++ b/guides/_subsections/common/select-target-application.md
@@ -8,7 +8,7 @@
{% endcapture %}
{% include howto_step.html
summary="Select the Target Application"
- image-name="4.1.0/select-target-application.png"
+ image-name="4.2.0/select-target-application.png"
caption="Clik the Dropdown arrow on the right side of Target prompt to select or create a target."
text=text-content
%}
diff --git a/guides/_subsections/configure-feature-level.md b/guides/_subsections/configure-feature-level.md
index 82ef6d07..2bffabb0 100644
--- a/guides/_subsections/configure-feature-level.md
+++ b/guides/_subsections/configure-feature-level.md
@@ -10,7 +10,7 @@ For those reasons, *Beta* features are hidden by default in the **Cryostat** UI.
WebSocket messages sent by the Cryostat backend when actions and state changes occur. The setting
diff --git a/guides/_subsections/create-a-custom-target.md b/guides/_subsections/create-a-custom-target.md
index 214695ca..42c5c00b 100644
--- a/guides/_subsections/create-a-custom-target.md
+++ b/guides/_subsections/create-a-custom-target.md
@@ -20,8 +20,8 @@ without going through the network stack.
Search for Custom Target tab and click Create to open the
Custom Target form.
+
+ 
node to test
the target connection.
+
+ 
Automated Rule"
- image-name="4.1.0/create-an-automated-rule-2.png"
+ summary="Configure the new Automated Rule in the create modal"
+ image-name="4.2.0/create-an-automated-rule-2.png"
text="
Name: Enter a name for the new rule. The form will alert you if the name @@ -138,11 +138,11 @@ jfrEventTypeIds(target).exists(t, t.startsWith('myorg.myapp.'))
Match Expression"
- image-name="4.1.0/create-an-automated-rule-3.png"
+ image-name="4.2.0/create-an-automated-rule-3.png"
caption="You can select a target JVM to view its properties and use them to build your Match Expression."
text="
- When you enter a Match Expression in the Match Expression field, the Match Expression Visualizer will highlight which targets are matched.
+ When you enter a Match Expression in the Match Expression field, the Match Expression Visualizer in the create modal will highlight which targets are matched.
Recording Options and Rule Parameters."
text="
@@ -178,12 +178,12 @@ jfrEventTypeIds(target).exists(t, t.startsWith('myorg.myapp.'))
Recording in the Active Recordings Table"
- image-name="4.1.0/create-an-automated-rule-6.png"
+ image-name="4.2.0/create-an-automated-rule-6.png"
caption="
Switch to the Recordings tab and view the new Recording in the Active Recordings
table."
@@ -276,4 +276,3 @@ spec:
```
Once the **Custom Resource** has been created, the rule will be pre-loaded into **Cryostat** and be available from startup without any further configuration needed.
-
diff --git a/guides/_subsections/download-an-active-or-archived-recording.md b/guides/_subsections/download-an-active-or-archived-recording.md
index 633178e0..e44d928b 100644
--- a/guides/_subsections/download-an-active-or-archived-recording.md
+++ b/guides/_subsections/download-an-active-or-archived-recording.md
@@ -27,7 +27,7 @@ or [`jfr`](https://dev.java/learn/jvm/jfr/tools/) for the heavy lifting on your
Recording"
- image-name="4.1.0/download-an-active-or-archived-recording-1.png"
+ image-name="4.2.0/download-an-active-or-archived-recording-1.png"
caption="
Click the action overflow \"︙\" three-dot menu on the right side of the
recording entry in the table, then click Download Recording.
@@ -37,7 +37,7 @@ or [`jfr`](https://dev.java/learn/jvm/jfr/tools/) for the heavy lifting on your
Recording File"
- image-name="4.1.0/download-an-active-or-archived-recording-2.png"
+ image-name="4.2.0/download-an-active-or-archived-recording-2.png"
caption="
Your browser will present you with its standard file-save dialog for both
the Archived Recording, and a .metadata.json file containing any
diff --git a/guides/_subsections/download-an-automated-rule.md b/guides/_subsections/download-an-automated-rule.md
index 41a099af..f4588b6a 100644
--- a/guides/_subsections/download-an-automated-rule.md
+++ b/guides/_subsections/download-an-automated-rule.md
@@ -6,12 +6,12 @@
- {% include howto_step.html - summary="Open Action Menu for a selected Rule" - image-name="4.1.0/download-an-automated-rule-1.png" + summary="Open the actions menu for a rule" + image-name="4.2.0/download-an-automated-rule-1.png" caption="Click the action overflow \"︙\" three-dot menu on the right side of selected rule entry in the table." %}
-
-
Click Download Button to Download. +Click Download
+
+ 
{% endcapture %}
{% include howto_step.html
summary="Navigate to Flight Recorder/Capture/Events"
- image-name="4.1.0/navigate-to-events-1.png"
+ image-name="4.2.0/navigate-to-events-1.png"
caption="
Supply JMX credentials to authenticate to the target, if necessary. If
the target is not configured with JMX authentication then the
@@ -74,7 +74,7 @@ delete **Custom Event Templates**.
event template definition .jfc file
somewhere on your local workstation, with read/write permissions.
@@ -30,21 +30,21 @@ validation or any hinting for event types and options.
JDK Mission Control"
- image-name="4.1.0/edit-template-with-jmc-2.png"
+ image-name="4.2.0/edit-template-with-jmc-2.png"
caption="The main JMC window after launch"
%}
.jfc
file on your local workstation.
diff --git a/guides/_subsections/getting-help.md b/guides/_subsections/getting-help.md
index eaa3b819..e96349c8 100644
--- a/guides/_subsections/getting-help.md
+++ b/guides/_subsections/getting-help.md
@@ -10,7 +10,7 @@ If you clear your browser's local storage, use a private browsing window, or use
{% include howto_step.html
summary="Welcome Tour"
- image-name="4.1.0/welcome-tour.png"
+ image-name="4.2.0/welcome-tour.png"
caption="Click through the Welcome Tour to learn how to use Cryostat."
text="The Welcome Tour provides an introduction to Cryostat's layout and indicates where further tutorials and help can be found."
%}
@@ -21,7 +21,7 @@ to begin the guided walkthrough of the **Cryostat Web** application.
{% include howto_step.html
summary="Tour Begins"
- image-name="4.1.0/guided-tour.png"
+ image-name="4.2.0/guided-tour.png"
caption="Click Next through the Welcome Tour to learn how to use **Cryostat**."
text="Continue through the tour to learn how the UI is organized and where you can find additional help."
%}
@@ -35,7 +35,7 @@ application masthead, then click Guided tour in the dropdown menu that ap
{% include howto_step.html
summary="Open Help Menu"
- image-name="4.1.0/masthead-help.png"
+ image-name="4.2.0/masthead-help.png"
caption="The ? Help menu on the application masthead contains additional resources."
text="Click Guided tour to relaunch the same tour."
%}
@@ -47,14 +47,14 @@ and will directly guide you through the UI as you complete them by operating on
{% include howto_step.html
summary="Open Help Menu"
- image-name="4.1.0/masthead-help.png"
+ image-name="4.2.0/masthead-help.png"
caption="The ? Help menu on the application masthead contains additional resources."
text="Click Quick Starts to view the tutorial catalog."
%}
{% include howto_step.html
summary="View the Quick Start Catalog"
- image-name="4.1.0/quick-start-catalog.png"
+ image-name="4.2.0/quick-start-catalog.png"
caption="The Quick Start catalog contains a series of tutorials you can follow to learn how to accomplish specific tasks."
text="Select and complete the tutorials which interest you. You can revisit this catalog at any time and re-do tutorials as many times as you like."
%}
diff --git a/guides/_subsections/navigate-the-dashboard.md b/guides/_subsections/navigate-the-dashboard.md
index b5da224a..e2da58ad 100644
--- a/guides/_subsections/navigate-the-dashboard.md
+++ b/guides/_subsections/navigate-the-dashboard.md
@@ -14,7 +14,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
-
{% capture target-jvm-details-text %}
- The Target JVM Details
carddisplays information about thetargetJVM application that is currently selected. There are two tabs that display different information: + The Target JVM Detailscarddisplays information about thetargetJVM application that is currently selected. There are three tabs that display different information:-
Details Tab - Displays information about the
targetJVM application, including: @@ -48,11 +48,14 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
+ -
Details Tab - Displays information about the
-
+ Lineage Tab - Displays an embedded Topology graph view isolating the
targetJVM application, the Discovery Node it's attached to, that Node's parent Node, up to the Realm level. +
{% endcapture %}
{% include howto_step.html
summary="Add the Target JVM Details
Card"
- image-name="4.1.0/dashboard/targetjvmdetails-preview.png"
+ image-name="4.2.0/dashboard/targetjvmdetails-preview.png"
caption="
Click on the Target JVM Details card for a preview.
"
@@ -65,17 +68,23 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
There are no extra steps in the creation wizard for this card. Click Finish to add the card to your dashboard.
+ 
+ 
+ Gallery view
+
+ 
The Gallery view of the Automated Analysis Card displays a Result, a report summary, for each Rule that was triggered in the selected Recording. In this view, each Rule is listed in categories based on the event type. For example, the Thrown Errors and the Thrown Exceptions Rules are part of the exceptions category, as seen in the figure above. By clicking on each Rule, you can view more details about the Rule and the Result that was generated.
+
+ 
Discouraged Management Agent Settings Rule result with a severity score of 25.0.
@@ -126,8 +135,8 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
List View
+
+ 
@@ -148,7 +157,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Add the Automated Analysis Card"
- image-name="4.1.0/dashboard/automatedanalysis-preview.png"
+ image-name="4.2.0/dashboard/automatedanalysis-preview.png"
caption="
Click on the Automated Analysis card for a preview.
"
@@ -159,8 +168,8 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
Perform Analysis
@@ -168,7 +177,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
+ 
Card Creation"
- image-name="4.1.0/dashboard/automatedanalysis-createrecording.png"
+ image-name="4.2.0/dashboard/automatedanalysis-createrecording.png"
caption="The card will be added to the dashboard with an empty state. The Create a Recording call to action will guide you through recording creation with suggested default settings. Return to the Dashboard once a recording has been started."
text=automated-analysis-perform-text
%}
@@ -176,7 +185,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
card displayed with a successful report."
text="After clicking Create Recording, the card should be populated with report data containing the Results of the Automated Analysis report."
%}
@@ -203,7 +212,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Add the MBean Metrics Chart Card"
- image-name="4.1.0/dashboard/mbeanmetrics-preview.png"
+ image-name="4.2.0/dashboard/mbeanmetrics-preview.png"
caption="Click on the MBean Metrics Chart card for a preview."
text=mbean-metrics-chart-text
%}
@@ -219,7 +228,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Configure the MBean Metrics Chart Card"
- image-name="4.1.0/dashboard/mbeanmetrics-configuration.png"
+ image-name="4.2.0/dashboard/mbeanmetrics-configuration.png"
caption="Click Next to provide card configuration."
text=configure-mbean-metrics-chart
%}
@@ -232,7 +241,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Finish Card Creation"
- image-name="4.1.0/dashboard/mbeanmetrics.png"
+ image-name="4.2.0/dashboard/mbeanmetrics.png"
caption="The MBean Metrics Chart card displayed with the Process CPU Load metric."
text=mbean-metrics-chart-finish
%}
@@ -262,7 +271,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Add the JFR Metrics Chart Card"
- image-name="4.1.0/dashboard/jfrmetrics-preview.png"
+ image-name="4.2.0/dashboard/jfrmetrics-preview.png"
caption="Click on the JFR Metrics Chart card. No preview is available."
text=jfr-metrics-chart-text
%}
@@ -278,7 +287,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Configure the JFR Metrics Chart Card"
- image-name="4.1.0/dashboard/jfrmetrics-configuration.png"
+ image-name="4.2.0/dashboard/jfrmetrics-configuration.png"
caption="Click Next to provide card configuration."
text=jfr-mbean-metrics-chart
%}
@@ -291,7 +300,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Finish Card Creation"
- image-name="4.1.0/dashboard/jfrmetrics-no-source.png"
+ image-name="4.2.0/dashboard/jfrmetrics-no-source.png"
caption="The JFR Metrics Chart card created with no source recording."
text=jfr-metrics-chart-created
%}
@@ -304,7 +313,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Start source Flight Recording"
- image-name="4.1.0/dashboard/jfrmetrics.png"
+ image-name="4.2.0/dashboard/jfrmetrics.png"
caption="The JFR Metrics Chart card displayed with the Memory Usage metric."
text=jfr-metrics-chart-finish
%}
@@ -330,7 +339,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Add the Diagnostics Card"
- image-name="4.1.0/dashboard/diagnostics-preview.png"
+ image-name="4.2.0/dashboard/diagnostics-preview.png"
caption="Click on the Diagnostics card. No preview is available."
text=diagnostics-card-text
%}
@@ -343,7 +352,7 @@ The *Dashboard* is the first view you will see when you log into **Cryostat**. I
{% endcapture %}
{% include howto_step.html
summary="Finish Card Creation"
- image-name="4.1.0/dashboard/diagnostics.png"
+ image-name="4.2.0/dashboard/diagnostics.png"
caption="The Diagnostics card."
text=diagnostics-card-created
%}
@@ -358,7 +367,7 @@ The Dashboard is highly customizable and can be configured to display the
Card to the Dashboard"
- image-name="4.1.0/dashboard/targetjvmdetails-preview.png"
+ image-name="4.2.0/dashboard/targetjvmdetails-preview.png"
caption="Open the card catalog by clicking the Catalog icon on the Dashboard toolbar."
text="Let's add the Target JVM Details card."
%}
@@ -366,14 +375,14 @@ The Dashboard is highly customizable and can be configured to display the
Card"
- image-name="4.1.0/dashboard/dashboard-resize.png"
+ image-name="4.2.0/dashboard/dashboard-resize.png"
caption="Click and drag the right edge of the card to resize it."
%}
Card to the Dashboard"
- image-name="4.1.0/dashboard/mbeanmetrics-preview.png"
+ image-name="4.2.0/dashboard/mbeanmetrics-preview.png"
caption="Open the card catalog by clicking the Catalog icon on the Dashboard toolbar."
text="Let's add the MBean Metrics Chart card this time."
%}
@@ -381,7 +390,7 @@ The Dashboard is highly customizable and can be configured to display the
Cards"
- image-name="4.1.0/dashboard/dashboard-rearrange.png"
+ image-name="4.2.0/dashboard/dashboard-rearrange.png"
caption="Click and drag the Target JVM Details card's header on top or to the right of the MBeans Metrics Chart card to swap their positions."
%}
+
+ 
card.Cards"
- image-name="4.1.0/dashboard/dashboard-cardkebab.png"
+ image-name="4.2.0/dashboard/dashboard-cardkebab.png"
caption="Click the Kebab icon on the card header to open the card actions menu."
text=remove-card-text
%}
@@ -432,14 +441,14 @@ By default, the `Default` layout is created for you. This layout contains the ca
Custom1."
%}
cards."
text=template-picker-guide-text
%}
@@ -512,14 +521,14 @@ By default, the `Default` layout is created for you. This layout contains the ca
alphanumeric, can only contain underscores, dashes, and periods, and must be 20 characters or less."
%}
Recording in a new **Cryostat** instance.
Archived Recordings. See Viewing Archived Recordings.
@@ -19,7 +19,7 @@ previously retrieved Recording in a new **Cryostat** instance.
.jfr file to upload. Note that the file must follow the Cryostat Archive Recording
@@ -30,7 +30,7 @@ previously retrieved Recording in a new **Cryostat** instance.
Metadata Labels"
- image-name="4.1.0/re-upload-a-recording-to-archives-3.png"
+ image-name="4.2.0/re-upload-a-recording-to-archives-3.png"
caption="
Click Show metadata options to add optional Metadata Labels to a Recording.
You can either add Labels by clicking the Add Label button, or by uploading
@@ -44,7 +44,7 @@ previously retrieved Recording in a new **Cryostat** instance.
Recording"
- image-name="4.1.0/re-upload-a-recording-to-archives-4.png"
+ image-name="4.2.0/re-upload-a-recording-to-archives-4.png"
caption="Click Upload and observe that the Recording is now present in
the Uploads tab of the Archives view."
%}
diff --git a/guides/_subsections/snapshot-a-recording.md b/guides/_subsections/snapshot-a-recording.md
index 4d78ec2a..8efbe605 100644
--- a/guides/_subsections/snapshot-a-recording.md
+++ b/guides/_subsections/snapshot-a-recording.md
@@ -34,7 +34,7 @@ at a given point in time.
snapshot"
- image-name="4.1.0/snapshot-a-recording-2.png"
+ image-name="4.2.0/snapshot-a-recording-2.png"
caption="
After clicking the Create button you will be returned to the
Active Recordings view and the new snapshot recording will be present
diff --git a/guides/_subsections/startstop-a-recording.md b/guides/_subsections/startstop-a-recording.md
index 271e1516..728dd04f 100644
--- a/guides/_subsections/startstop-a-recording.md
+++ b/guides/_subsections/startstop-a-recording.md
@@ -15,7 +15,7 @@ The first and most basic Flight Recorder workflow is to start a `Flight Recordin
Recording"
- image-name="4.1.0/startstop-a-recording-1.png"
+ image-name="4.2.0/startstop-a-recording-1.png"
text="
Enter a Name for the new Recording. The form will alert you if the name
@@ -49,7 +49,7 @@ The first and most basic Flight Recorder workflow is to start a `Flight Recordin
Recording"
- image-name="4.1.0/startstop-a-recording-2.png"
+ image-name="4.2.0/startstop-a-recording-2.png"
text="
In many cases, the Advanced Options can be left with their
@@ -108,7 +108,7 @@ The first and most basic Flight Recorder workflow is to start a `Flight Recordin
{% endcapture %}
{% include howto_step.html
summary="Stop the Recording"
- image-name="4.1.0/startstop-a-recording-3.png"
+ image-name="4.2.0/startstop-a-recording-3.png"
text=stop-the-recording-additional-content
%}
-
{% include howto_step.html
- summary="Navigate to the Console/Security view"
- image-name="4.1.0/navigate-to-security.png"
+ summary="Navigate to the Security/Credentials view"
+ image-name="4.2.0/navigate-to-security.png"
text="
- First, navigate to the Console/Security view. The Store Credentials table
+ First, navigate to the Security/Credentials view. The Store Credentials table
lists all credentials in Cryostat's
Keyring. Click Add to define a new credential. " @@ -18,7 +18,7 @@ before it can access the **JDK** `Flight Recordings` on your `target` **JVMs**. -
{% include howto_step.html
summary="Enter your Credentials"
- image-name="4.1.0/store-credentials-1.png"
+ image-name="4.2.0/store-credentials-1.png"
text="
A modal will appear. You can select a
targetJVM to view its properties. @@ -35,7 +35,7 @@ before it can access the **JDK** `Flight Recordings` on your `target` **JVMs**. -
{% include howto_step.html
summary="Test your Credentials"
- image-name="4.1.0/store-credentials-3.png"
+ image-name="4.2.0/store-credentials-3.png"
text="
Navigate to the Test tab to use the Credential Test table
to check if the entered credential is valid for the matched
targets. @@ -66,7 +66,7 @@ before it can access the **JDK** `Flight Recordings` on your `target` **JVMs**. (Alternative to Steps 1 and 2) Store Credentials when Connecting to aTargetJVM " - image-name="4.1.0/navigate-to-recordings-1.png" + image-name="4.2.0/navigate-to-recordings-1.png" text=" Alternatively, credentials may also be stored if you navigate to either the Flight Recorder/Capture/Recordings view or the Flight Recorder/Capture/Events view and select atarget@@ -80,7 +80,7 @@ before it can access the **JDK** `Flight Recordings` on your `target` **JVMs**. -
{% include howto_step.html
summary="View your Stored Credentials"
- image-name="4.1.0/store-credentials-2.png"
+ image-name="4.2.0/store-credentials-2.png"
text="
The Store Credentials table will update with a row for each of the credentials you have stored in the
Keyring. The matchExpression is visible along with a count of the number of knowntargetapplications that these credentials will apply to. You can expand the row to display a list of those matchedtargetapplications. For security reasons it is not possible to view the storedusernameandpasswordassociated with a credential definition in theKeyring. " diff --git a/guides/_subsections/upload-an-automated-rule.md b/guides/_subsections/upload-an-automated-rule.md index dfd1eeb2..9a90694c 100644 --- a/guides/_subsections/upload-an-automated-rule.md +++ b/guides/_subsections/upload-an-automated-rule.md @@ -23,7 +23,7 @@ Below is an example of a rule file content: - {% include howto_step.html summary="Navigate to the Flight Recorder/Capture/Automated Rules Tab" - image-name="4.1.0/create-an-automated-rule-1.png" + image-name="4.2.0/create-an-automated-rule-1.png" %}
- @@ -32,23 +32,23 @@ Below is an example of a rule file content:
- {% include howto_step.html summary="Open Automated Rules upload modal" - image-name="4.1.0/upload-an-automated-rule-1.png" + image-name="4.2.0/upload-an-automated-rule-1.png" %}
- {% include howto_step.html - summary="Attach a Rule File by Dragging & Dropping or clicking Browse...." - image-name="4.1.0/upload-an-automated-rule-2.png" + summary="Attach a rule file by dragging and dropping it or clicking Upload" + image-name="4.2.0/upload-an-automated-rule-2.png" caption="Select a rule file to upload. The file should not include the "id" field as this will be assigned by the application database." %}
-
-
Click Submit Button to Upload. +Click Submit to upload the rule -
{% include howto_step.html
summary="Observe the new rule in the Automated Rules table"
- image-name="4.1.0/create-an-automated-rule-5.png"
+ image-name="4.2.0/create-an-automated-rule-5.png"
caption="
The new rule will appear in the Automated Rules table."
%}
diff --git a/guides/_subsections/use-topology-view.md b/guides/_subsections/use-topology-view.md
index 631eda74..c067fa2b 100644
--- a/guides/_subsections/use-topology-view.md
+++ b/guides/_subsections/use-topology-view.md
@@ -33,13 +33,13 @@ The *Topology View* provides a visual presentation of all the discovered **JVM**
{% include howto_step.html
summary="View JVM Applications with Graph View"
- image-name="4.1.0/topology-1.png"
+ image-name="4.2.0/topology-1.png"
caption="View JVM applications with Topology Graph view."
text=topology-graphview-guide-text
%}
{% include howto_step.html
summary="View JVM Applications with List View"
- image-name="4.1.0/topology-2.png"
+ image-name="4.2.0/topology-2.png"
caption="View JVM applications with Topology List view."
text=topology-listview-guide-text
%}
@@ -72,13 +72,13 @@ The *Topology View* provides a visual presentation of all the discovered **JVM**
{% include howto_step.html
summary="View JVM Details"
- image-name="4.1.0/topology-3.png"
+ image-name="4.2.0/topology-3.png"
caption="View
targetJVM’s details with drawer panel." text=sidebar-detail-guide-text %} {% include howto_step.html summary="View JVM's Associated Resources" - image-name="4.1.0/topology-4.png" + image-name="4.2.0/topology-4.png" caption="View JVM's associated resources with drawer panel." text=sidebar-resource-guide-text %} @@ -100,13 +100,13 @@ The *Topology View* provides a visual presentation of all the discovered **JVM** {% include howto_step.html summary="Perform Actions for a Single JVM" - image-name="4.1.0/topology-5.png" + image-name="4.2.0/topology-5.png" caption="Perform actions on an individual JVM." text=single-action-guide-text %} {% include howto_step.html summary="Perform Actions for a Group of JVMs" - image-name="4.1.0/topology-6.png" + image-name="4.2.0/topology-6.png" caption="Perform actions on a group of JVMs." text=bulk-action-guide-text %} diff --git a/guides/_subsections/using-smart-triggers.md b/guides/_subsections/using-smart-triggers.md index 878b71a4..4abc8c29 100644 --- a/guides/_subsections/using-smart-triggers.md +++ b/guides/_subsections/using-smart-triggers.md @@ -71,6 +71,25 @@ This example uses the same custom trigger criteria as the preceding examples.
+ -
+ ++
Using the Cryostat UI
+ {% include howto_step.html + summary="Navigate to the Capture/Triggers view" + image-name="4.2.0/create-a-smart-trigger-1.png" + caption=" + After navigating to the Capture/Triggers page and clicking the Create button, a form will be displayed allowing for the creation of smart triggers. Simply select the MBean Attribute for the trigger and set the condition, then select a target duration if desired and select an event template to be used. Custom event templates may be used as well as the built in templates. For more information on the available MBean Attributes, see Supported MBean Attributes. + " + %} + {% include howto_step.html + summary="View active Smart Triggers" + image-name="4.2.0/create-a-smart-trigger-2.png" + caption=" + Once the Smart Trigger has been created it will be displayed in the table, showing the conditions that must be met as well as the Recording Template used for starting a Recording once conditions are met. From this table, the user can filter by any of the displayed attributes (ID, duration, condition, template), for instance entering Profiling will display any active Smart Triggers using the Profiling template. Triggers may also be deleted, stopping them from activating. + " + %} +
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+