-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(diagnostics): Add guide for the diagnostics card (#214)
- Loading branch information
1 parent
47fc6de
commit 5910122
Showing
4 changed files
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
## [Perform Garbage Collection](#perform-garbage-collection) | ||
<ol> | ||
<li> | ||
{% capture perform-garbage-collection-text %} | ||
<p> | ||
The <i>Diagnostics</i> <code>card</code> allows | ||
you to perform diagnostic operations on a <code>target</code> <b>JVM</b> through remote access to supported <b>Java MXBeans</b>. | ||
</p> | ||
<p> | ||
Currently <b>Cryostat</b> supports invoking garbage collection on <code>target</code> <b>JVMs</b>. | ||
</p> | ||
{% endcapture %} | ||
{% include howto_step.html | ||
summary="Add the <i>Diagnostics</i> <code>Card</code>" | ||
image-name="4.0.0/dashboard/add-diagnostics-card.png" | ||
caption="Click on the <i>Diagnostics</i> <code>card</code> for a preview." | ||
text=perform-garbage-collection-text | ||
%} | ||
</li> | ||
<li> | ||
{% capture diagnostics-card-finish %} | ||
<p> | ||
After clicking <i>Finish</i>, the <code>card</code> will be added to the dashboard. You can click the <i>Start Garbage Collection</i> button in the middle of the <code>card</code> at any time to trigger a garbage collection cycle. | ||
</p> | ||
{% endcapture %} | ||
{% include howto_step.html | ||
summary="Finish <code>Card</code> Creation" | ||
image-name="4.0.0/dashboard/diagnostics-card.png" | ||
caption="The <i>Diagnostics</i> <code>card</code> displayed on the dashboard." | ||
text=diagnostics-card-finish | ||
%} | ||
</li> | ||
</ol> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.