Skip to content

Commit

Permalink
docs(guides): update guide for starting/stopping recordings (#190)
Browse files Browse the repository at this point in the history
* update screenshot

* document 'restart if recording already exists' checkbox

* add link to guide for creating custom event template

* remove unnecessary formatting from term
  • Loading branch information
andrewazores authored Jun 10, 2024
1 parent 4f54328 commit 72be645
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions guides/_subsections/startstop-a-recording.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ The first and most basic workflow is to start a `Flight Recording` in a `target`
<p>
Enter a <i>Name</i> for the new <code>Recording</code>. The form will alert you if the name
entered has an invalid format. If the name is already in use then the
creation will fail and you will need to try again.
creation will fail and you will need to try again, or check the <i>Restart if recording already exists</i>
checkbox to allow Cryostat to reuse the same recording name for a new recording with new settings.
</p>
<p>
Select the <i>Duration</i> of the <code>Recording</code>. The duration can be specified in
Expand All @@ -35,6 +36,9 @@ The first and most basic workflow is to start a `Flight Recording` in a `target`
duration setting, and the <i>Profiling</i> template is useful for
collecting extra information for troubleshooting a specifically
identified problem with a fixed <code>Recording</code> duration.
You can also
<a href='#download-edit-and-upload-a-customized-event-template'>upload a custom Event Template</a>
and select it here.
</p>
<p>
To learn about <code>Metadata Options</code>, see <a href='#add-and-edit-recording-metadata-labels'>Add and Edit Recording Metadata Labels</a>.
Expand Down Expand Up @@ -87,7 +91,7 @@ The first and most basic workflow is to start a `Flight Recording` in a `target`
<i>Stop</i> button to end the data collection.
</p>
<p>
If the <code>Recording</code> has a <code>Fixed Duration</code> then it will automatically stop
If the <code>Recording</code> has a fixed duration then it will automatically stop
after the <code>target</code> <b>JVM</b> measures that the duration has elapsed. If the
<code>Recording</code> was created with a <code>Continuous Duration</code> then it will collect
data until explicitly stopped.
Expand Down
Binary file modified images/3.0.0/navigate-to-recordings-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 72be645

Please sign in to comment.