Procedure

1. Navigate to the Recordings menu or the Events menu on your Cryostat instance.

   Note

   The remaining steps use the Recordings menu as an example, but you can follow similar steps on the Events menu.

2. From the Recordings panel, select your target JVM from the drop-down list. You will receive a prompt if your target JVM does not contain a trusted SSL certificate, as demonstrated in the following example:

   Figure 1.1. SSL error message

   

3. Click the Security button. A window opens on the Cryostat web console that shows the Security dialog box.

   Figure 1.2. Security dialog box

   

4. Click the Upload button. An Upload SSL certificate window opens on your Cryostat web console.

   Figure 1.3. Upload SSL certificate window

   

5. Click the Browse button and locate the SSL certificate on your local system.

   Important

   Your SSL certificate must be DER-encoded in either binary or base64 format. Cryostat supports .der and .cer file extensions.

6. Restart your Cryostat instance.
7. Navigate to the Recordings menu on your Cryostat instance.
8. If you get prompted with an Authentication Required message on your web console, enter your credentials. Some target JVMs require you to authenticate before you can access the data for auditing purposes.

Procedure

1. Click the Security menu item.

2. From the Store Credentials window, click the Add button. The Store Credentials window opens.

   Figure 1.5. Example of a Store Credentials window

   

3. In the Match Expression field, specify the match expression details.

   Note

   Select the question mark icon to view suggested syntax in a Match Expression Hint snippet.

4. Click Save. A table entry is displayed in the Store Credentials window that shows the Match Expression for your target JVM.

   Figure 1.6. Example of a table entry on the Store Credentials pane

   
   Important

   For security purposes, a table entry does not display your username or password.

5. Optional: If you want to delete your stored credentials for a target JVM, you can select the checkbox next to the table entry for this target JVM and then click Delete.

Procedure

1. On the Active Recordings tab, select the checkbox for your JFR recording. The Archive button is activated in the Active Recordings toolbar.

   Figure 2.1. Archive button for your JFR recording

   

2. Click the Archive button. Cryostat creates an archived recording of your JFR recording.

   You can view your archived recording from under the Archived Recordings tab along with any other recording that relates to your selected target JVM.

   Alternatively, you can view your archived recording from under the All Targets table.

   Figure 2.2. Example of a listed target JVM application that is under the All Targets table

   
   Tip

   To remove a target JVM entry that does not have an archived recording, select the Hide targets with zero recordings checkbox.

   After you click on the twistie (v) beside the JVM target entry, you can access a filter function, where you can edit labels to enhance your filter or click the Delete button to remove the filter.

3. From the All Targets table, select the checkbox beside each target JVM application that you want to review. The table lists each archived recording and its source location.

4. Go to the All Archives table. This table looks similar to the All Targets table, but the All Archives table lists target JVM applications from files that Cryostat archived inside Cryostat.

   Note

   If an archived file has no recognizable JVM applications, it is still listed on the All Archives table but opens within a nested table under the heading lost.

5. Optional: To delete an archived recording, select the checkbox next to the specific archived JFR recording item, and click Delete when prompted.

   Figure 2.3. Deleting an archived JFR recording

   
   Note

   Cryostat assigns names to archived recordings based on the address of the target JVM’s application, the name of the active recording, and the timestamp of the created archived recordings.

Procedure

1. Navigate to the Recordings menu or the Archives menu on your Cryostat instance.

   Note

   The remaining steps use the Recordings menu as an example, but you can follow similar steps on the Archives menu.

2. Determine the recording you want by clicking either the Active Recordings tab or the Archived Recordings tab.

3. Locate your listed JFR recording and then select its overflow menu.

   Figure 2.4. Viewing a JFR recording’s overflow menu

   

4. Choose one of the following options:

   1. From the overflow menu, click Download Recording. Depending on how you configured your operating system, a file-save dialog opens. Save the JFR binary file and the JSON file to your preferred location.
   2. From the All Targets table, select the overflow menu for your listed JFR recordings. Click Download to save the archived file along with its JSON file, which contains metadata and label information, to your local system.

5. Optional: View the downloaded file with the Java Mission Control (JMC) desktop application.

   Note

   If you do not want to download the .jfr file, but instead want to view the data from your recording on the Cryostat application, you can click the View in Grafana option.

Procedure

1. Go to the Archives menu on your Cryostat instance.

   Figure 2.5. Archives menu on the Cryostat web console

   

2. Optional: From the Uploads table, you can view all of your uploaded JFR recordings. The Uploads table also includes a filtering mechanism similar to other tables, such as the All Targets table, and other output. You can also use the filtering mechanism on the Archives menu to find an archived file that might have no recognizable target JVM application.

   Figure 2.6. The Uploads table in the Archives menu

   

3. Click the upload icon. A Re-Upload Archived Recording window opens in your Cryostat web console:

   Figure 2.7. Re-Upload Archived Recording window

   
4. In the JFR File field, click Upload.

5. Locate the JFR recording files, which are files with a .jfr extension, and then click Submit.

   Note

   Alternatively, you can drag and drop .jfr files into the JFR File field.

Procedure

1. On the Dashboard panel for your Cryostat instance, select a Target JVM from the drop-down list.

2. Optional: On the Topology panel, you can define a target JVM by selecting the Add to view icon. After you select the icon, a window opens for defining a custom target connection URL.

   1. In the Connection URL field, enter the URL for your JVM’s Java Management Extension (JMX) endpoint.
   2. Optional: In the Alias field, enter an alias for your JMX Service URL.

   3. Click Create.

      Figure 3.1. Create Target dialog box

      

3. From the navigation menu on the Cryostat web console, click Events. An Authentication Required dialog might open on your web console. If prompted, enter your Username and Password in the Authentication Required dialog box, and click Save to provide your credentials to the target JVM.

   Note

   If the selected target JMX has SSL certification enabled for JMX connections, you must add its certificate when prompted.

   Cryostat can encrypt and store credentials for a target JVM application in a database that is stored on a persistent volume claim (PVC) on Red Hat OpenShift.

4. Under the Event Templates tab, locate your listed event template and then select its more options menu.

5. From the more options menu, click Download. Depending on how you configured your operating system, a file-save dialog opens. Save the file to your preferred location.

   Figure 3.2. Example of an event template’s more options menu

   

6. Open the file with your default file editor and edit the file to meet your needs. You must save your file to retain your configuration changes.

   Note

   You can add values to the description and provider attributes that can help with identifying your file at a later stage.

7. From the Events menu, go to the Event Templates tab then click the Upload icon. A Create Custom Event Template window opens in your Cryostat web console.

   Figure 3.3. Create Custom Event Template window

   
8. Click Upload and use your default file editor to upload one or more configured event template files to the Cryostat web console. You can also drag and drop the files into the Template XML window.
9. Click the Submit button. The Event Templates tab opens on your Cryostat web console, where you can now view your custom event template.

10. Optional: After you create your event template, you can choose one of the following options for using your template to create a JFR recording:

    • From the Automated Rules menu, click Create and then select an event template from the Template list.
    • From the Events menu, locate your listed event template, then from the more options menu, select Create Recording.
    • From the Recordings menu, under the Active Recordings tab, click Create.

Procedure

1. Go to the Recordings menu or the Archives menu on your Cryostat instance.
2. Depending on your needs, click either the Active Recordings tab or the Archived Recordings tab.

3. Locate your JFR recording and then select the overflow menu.

   Figure 4.1. Overflow menu items available for an example JFR recording

   
4. From the overflow menu, click the View in Grafana option. The Grafana application opens in a new web browser window.
5. Click the sign-in icon on the Grafana dashboard.

6. Determine your credentials by issuing the following commands in your terminal.

   <cryostat_name>=$(kubectl get cryostat -o jsonpath='{$.items[0].metadata.name}')
   
   oc get secret $<cryostat_name>-grafana-basic -o jsonpath='{$.data.GF_SECURITY_ADMIN_USER}' | base64 -d
   
   oc get secret $<cryostat_name>-grafana-basic -o jsonpath='{$.data.GF_SECURITY_ADMIN_PASSWORD}' | base64 -d

   You can also locate your credentials from the Grafana Secret custom resource (CR) on the Cryostat details page on Red Hat OpenShift.

   Figure 4.2. The Grafana Secret CR on the Cryostat details page on OpenShift

   
7. Enter your credentials in the Grafana web console login page. A dashboard window opens and shows your JFR recording’s data in various time-series plots.

8. Optional: Interact with any plot by selecting a time-series segment on the plot. Grafana expands the on-screen data to show only the data for that time interval.

   Figure 4.3. Example of a Grafana dashboard with plotted graphs