diff --git a/guides/_subsections/download-edit-and-upload-a-customized-event-template.md b/guides/_subsections/download-edit-and-upload-a-customized-event-template.md index 69e1ec2..3bbfb02 100644 --- a/guides/_subsections/download-edit-and-upload-a-customized-event-template.md +++ b/guides/_subsections/download-edit-and-upload-a-customized-event-template.md @@ -17,14 +17,21 @@ all. It may be useful to use either of these as a starting point and tailor it to meet your specific monitoring/profiling needs by including/excluding events, increasing/decreasing sample rates, raising/lowering thresholds, etc. -Of special note, **JFR** allows for the definition of application-specific custom -events, which would not be captured in either of the default templates above. +Of special note, **JFR** allows for the definition of application-specific or +framework-level custom events, which would not be captured in either of the default +templates above. You can [view all of the **JFR** *Event Types*](#view-jfr-event-types) +for a *Target* application. **Cryostat** also provides the ALL meta-template, which enables all event types in the selected `target` application, with default values for each event option. This is not a true *Event Template* and does not have an `XML` definition to download. +The steps below assume that you have at least one *Target* discovered. If you select +a discovered *Target* then you can use its templates as starting points for your +customizations. If you do not first select a *Target* then you may still upload and +delete **Custom Event Templates**. +
  1. {% include_relative _subsections/common/select-target-application.md diff --git a/guides/_subsections/view-jfr-event-types.md b/guides/_subsections/view-jfr-event-types.md new file mode 100644 index 0000000..a74ee95 --- /dev/null +++ b/guides/_subsections/view-jfr-event-types.md @@ -0,0 +1,50 @@ +## [View JFR Event Types](#view-jfr-event-types) +The **JVM** comes with many built-in **JDK Flight Recorder** *Event Types* out-of-the-box. +You can also register new *event types* at the framework- or application-level using the +`jdk.jfr` API. **Cryostat** can list out all of a *Target* **JVM**'s registered *event types* +so you can see what kind of data may be captured by **Flight Recordings**. + +
      +
    1. + {% include_relative _subsections/common/select-target-application.md + select-target-application-additional-content=" + The Target selected will provide the base Continuous and + Profiling template definitions to start from. Most target + applications will be interchangeable here. + " + %} +
    2. +
    3. + {% capture navigate-to-events-include-text %} +

      + If the Target JVM has SSL/TLS enabled on JMX connections then it may be + 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. + + + +

      + {% endcapture %} + {% include howto_step.html + summary="Navigate to Events" + image-name="4.0.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 + connection attempt will continue without prompting for credentials. + " + text=navigate-to-events-include-text + %} +
    4. +
    5. + {% include howto_step.html + summary="Navigate to Event Types" + image-name="4.0.0/navigate-to-event-types-1.png" + caption=" + Select the Event Types tab to view a table listing of all the JDK Flight Recorder + Event Types registered in the Target JVM. + " + %} +
    6. +
    diff --git a/guides/index.md b/guides/index.md index d4c4eb7..92fa78b 100644 --- a/guides/index.md +++ b/guides/index.md @@ -33,6 +33,8 @@ common actions and workflows of interest and why they are useful. {% include_relative _subsections/re-upload-a-recording-to-archives.md %} +{% include_relative _subsections/view-jfr-event-types.md %} + {% include_relative _subsections/download-edit-and-upload-a-customized-event-template.md %} {% include_relative _subsections/edit-template-with-jmc.md %} diff --git a/images/4.0.0/navigate-to-event-types-1.png b/images/4.0.0/navigate-to-event-types-1.png new file mode 100644 index 0000000..f67479f Binary files /dev/null and b/images/4.0.0/navigate-to-event-types-1.png differ