Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Custom JFR event templates with Cryostat 2.0

 

November 16, 2021
Andrew Azores Elliott Baron
Related topics:
ContainersJavaKubernetesOperators
Related products:
Red Hat OpenShift

Share:

    Welcome back to our series of hands-on introductions to using Cryostat 2.0. This article shows you how to preconfigure custom event templates for Java application monitoring with JDK Flight Recorder (JFR). First, you'll use the new Cryostat Operator and a Red Hat OpenShift ConfigMap to create a custom event template, then you'll instruct the Cryostat Operator to use the ConfigMap when deploying Cryostat. You can use the OpenShift console to interact with Cryostat or edit the YAML file for your Cryostat custom resource. We'll demonstrate both approaches.

    Read all of the articles in this series:

    • Part 1: Get started with Cryostat 2.0
    • Part 2: Configuring Java applications to use Cryostat
    • Part 3: Java monitoring for custom targets with Cryostat
    • Part 4: Automating JDK Flight Recorder in containers
    • Part 5: Creating Custom JFR event templates with Cryostat 2.0

    Note: Cryostat is JDK Flight Recorder for Kubernetes or Red Hat OpenShift. The Red Hat build of Cryostat 2.0 is now widely available in technology preview. The Red Hat build includes the Cryostat Operator to simplify and automate Cryostat deployment on Red Hat OpenShift.

    Create a custom template and ConfigMap

    With Cryostat, you can download existing template files directly from a Java virtual machine (JVM). Once you've downloaded a template file to your local machine, you can use the JDK Mission Control (JMC) Template Manager to easily edit the template to suit your needs.

    After customizing the template file, it's fairly simple to create a ConfigMap from it. This ConfigMap stores the template file inside of the cluster where Cryostat will run. You can use oc or kubectl in the namespace where Cryostat is to be deployed. Here's the source if you use the former:

    
    $ oc create configmap my-template --from-file=/path/to/custom.jfc
    

    This command creates a ConfigMap named my-template from a file on your local machine, located at /path/to/custom.jfc. The file will be placed inside the ConfigMap under the custom.jfc filename.

    Add your ConfigMap to the Cryostat Operator

    Once you've created a ConfigMap, you only need to instruct the Cryostat Operator to use it when deploying Cryostat. You can do this when you create a Cryostat custom resource, or by updating an existing one. If you're installing Cryostat using the OpenShift console, select Event Templates under the Cryostat custom resource that you want to update. Choose Add Event Template. The Config Map Name drop-down list will display all ConfigMaps in the local namespace. Select the ConfigMap containing the event template you just created. For Filename, enter the name of the .jfc file within the ConfigMap. In Figure 1, we're using custom.jfc, which we created in the previous section.

    Creating an OpenShift ConfigMap containing a JDK .jfc event template definition file.
    Figure 1. Create a ConfigMap with a JDK .jfc event template definition file.

    You can also work directly with the YAML for the Cryostat custom resource. The process is similar to what you did in the console. Add an eventTemplates property to the spec section, if one isn't already present. Then, add an array entry with configMapName referencing the name of the ConfigMap, and a filename referencing the filename within the ConfigMap. The YAML below mirrors what we did in the OpenShift console example in Figure 1.

    
    apiVersion: operator.cryostat.io/v1beta1
    
    kind: Cryostat
    
    metadata:
    
      name: cryostat-sample
    
    spec:
    
      eventTemplates: 
    
      - configMapName: custom-template
    
        filename: my-template.jfc
    
    

    Once you've saved your changes to the Cryostat custom resource, the Cryostat Operator will deploy Cryostat with this template preconfigured. Visiting the Cryostat web application will show that the template is present and available to use for creating new JDK flight recordings, as you can see in Figure 2.

    The Event Template list displays the template created via ConfigMap.
    Figure 2. The Event Template list displays the template created via ConfigMap.

    Conclusion

    In this article, you've learned how to preconfigure Cryostat with customized event templates using OpenShift ConfigMaps. You can use customized templates to gather the specific data you need in your JDK flight recordings. Visit Cryostat.io and see the other articles in this series for further details:

    • Introduction to Cryostat: JDK Flight Recorder for containers
    • Get started with Cryostat 2.0
    • Configuring Java applications to use Cryostat
    • Java monitoring for custom targets with Cryostat
    • Automating JDK Flight Recorder in containers
    Last updated: September 20, 2023

    Related Posts

    • Introduction to Cryostat: JDK Flight Recorder for containers

    • Announcing Cryostat 2.0: JDK Flight Recorder for containers

    • Configuring Java applications to use Cryostat

    • Java monitoring for custom targets with Cryostat

    Recent Posts

    • GuideLLM: Evaluate LLM deployments for real-world inference

    • Unleashing multimodal magic with RamaLama

    • Integrate Red Hat AI Inference Server & LangChain in agentic workflows

    • Streamline multi-cloud operations with Ansible and ServiceNow

    • Automate dynamic application security testing with RapiDAST

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue