Skip to content

Commit

Permalink
feat(eventtypes): document Event Types view
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewazores committed Dec 13, 2024
1 parent 153c521 commit 236c2cf
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>ALL</code> 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**.

<ol>
<li>
{% include_relative _subsections/common/select-target-application.md
Expand Down
50 changes: 50 additions & 0 deletions guides/_subsections/view-jfr-event-types.md
Original file line number Diff line number Diff line change
@@ -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**.

<ol>
<li>
{% include_relative _subsections/common/select-target-application.md
select-target-application-additional-content="
The <i>Target</i> selected will provide the base <code>Continuous</code> and
<code>Profiling</code> template definitions to start from. Most target
applications will be interchangeable here.
"
%}
</li>
<li>
{% capture navigate-to-events-include-text %}
<p>
If the <i>Target</i> <b>JVM</b> has <code>SSL/TLS</code> enabled on <b>JMX</b> connections then it may be
necessary to add the <i>Target's</i> certificate to <b>Cryostat's</b> trust store. Go
to <a href="{{ page.url }}#add-a-trusted-certificate">Add a Trusted Certificate</a>
and return to this section after completing that guide.
<a href="{{ site.url }}/images/4.0.0/navigate-to-events-2.png" target="_blank">
<img src="{{ site.url }}/images/4.0.0/navigate-to-events-2.png">
</a>
</p>
{% endcapture %}
{% include howto_step.html
summary="Navigate to Events"
image-name="4.0.0/navigate-to-events-1.png"
caption="
Supply <b>JMX</b> credentials to authenticate to the target, if necessary. If
the target is not configured with <b>JMX</b> authentication then the
connection attempt will continue without prompting for credentials.
"
text=navigate-to-events-include-text
%}
</li>
<li>
{% include howto_step.html
summary="Navigate to Event Types"
image-name="4.0.0/navigate-to-event-types-1.png"
caption="
Select the <i>Event Types</i> tab to view a table listing of all the <b>JDK Flight Recorder</b>
<i>Event Types</i> registered in the <i>Target JVM</i>.
"
%}
</li>
</ol>
2 changes: 2 additions & 0 deletions guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
Binary file added images/4.0.0/navigate-to-event-types-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 236c2cf

Please sign in to comment.