Chapter 4. Labels for JFR recordings

Procedure

1. From your Cryostat web console, click Flight Recorder > Capture > Recordings.
2. In the Recordings panel, click Create.

3. In the Custom Flight Recording tab, expand Show metadata options.

   Note

   In the Custom Flight Recording tab, you must complete any mandatory field that is marked with an asterisk.

4. Click Add label.

   Figure 4.1. The Add Label button that is displayed under the Custom Flight Recording tab

   
5. Click the key=value button and then use the text entry field to specify an appropriate key and value. For example, if you want to file an issue with the recordings, you could specify reason as the key and then specify an issue type as the value (for example, reason=service.outage). Ensure that you include an equals (=) sign between the specified reason and value.

6. Click Create to create your JFR recording. Your recording is then shown in the Recordings panel along with any specified recording labels and custom labels.

   Tip

   You can access archived JFR recordings from the Flight Recorder > Analyze > Archives menu. See "Uploading a JFR recording to the Cryostat archives location" in (Using Cryostat to manage a JFR recording).

Procedure

1. On your Cryostat web console, click the Flight Recorder > Capture > Recordings menu.
2. In the Recordings panel, locate your JFR recording, and then select the checkbox next to it.

3. Click Edit Labels. An Edit labels pane opens in your Cryostat web console, which you can use to add, edit, or delete labels for your JFR recording.

   Tip

   You can select multiple JFR recordings by selecting the checkbox that is next to each recording. Click the Edit Labels button if you want to bulk edit recordings that contain the same labels or add new identical labels to multiple recordings.

   Figure 4.3. The Edit labels section that is displayed in the Recordings panel

   

4. Optional: You can perform any of the following actions from the Edit labels pane:

   1. Click Add label to create a label.
   2. Delete a label by clicking the x next to the label.
   3. Edit a label by modifying any content in a field.
5. Click Save.

6. Optional: You can archive your JFR recordings along with their labels by completing the following steps:

   1. Select the checkbox next to the recording’s name.

   2. Click the Archive button. You can locate your recording in the Flight Recorder > Analyze > Archives view.

      By archiving your recording with its labels, you can enhance your search capabilities when you want to locate the recording at a later stage. You can also add additional labels to any recording that you uploaded to the Cryostat archives.

      Note

      Cryostat preserves any labels with the recording for the lifetime of the archived recording.