1.4. 自定义事件模板
在 Cryostat 2 中,您可以配置 Red Hat build of Cryostat Operator YAML 配置文件的 eventTemplates
属性,使其包含多个自定义模板。事件模板概述了 JDK Flight Recording (JFR)的事件记录标准。您可以通过关联的事件模板配置 JFR。
默认情况下,Red Hat build of Cryostat Operator 包括一些预先配置的事件模板。这些预先配置的事件模板可能无法满足您的需要,因此您可以使用 Red Hat build of Cryostat Operator 为 Cryostat 实例生成自定义事件模板,并将这些模板存储在 ConfigMaps 中以便更轻松地检索。您可以使用以下方法生成自定义事件模板:
- 使用 Red Hat OpenShift Web 控制台将事件模板上传到自定义资源中。
- 在 Red Hat OpenShift web 控制台中编辑 Cryostat 自定义资源的 YAML 文件。
在 ConfigMap
中存储自定义事件模板后,您可以使用此自定义事件模板部署新的 Cryostat 实例。然后,您可以使用带有 JFR 的自定义事件模板来监控 Java 应用程序以满足您的需要。
先决条件
- 使用 Red Hat OpenShift Web 控制台登录到 OpenShift Container Platform。
- 登录到 Cryostat web 控制台。
流程
要下载默认事件模板,请导航到 Cryostat web 控制台并从 Events 菜单中点 Downloads。
注意事件模板采用 XML 格式,文件扩展名为
.jfc
。- 可选: 如果要自定义事件模板,请使用文本编辑器或 XML 编辑器编辑下载的默认事件模板,以配置模板以满足您的需要。
-
通过在 CLI 中输入
oc login
命令登录到您的 Red Hat OpenShift Web 控制台。 在 CLI 中输入以下命令来从事件模板创建
ConfigMap
资源。您必须在要部署 Cryostat 应用程序的路径中发出该命令。您可以使用此资源存储运行 Cryostat 实例的集群中的事件模板文件。使用 CLI 创建 ConfigMap 资源的示例
$ oc create configmap <template_name> --from-file=<path_to_custom_event_template>
- 在 Red Hat OpenShift web 控制台中,点 Operators > Installed Operators。
- 从可用 operator 列表中,选择 Red Hat build of Cryostat。
在 Operator 详情页面的 Details 选项卡下,创建一个 Cryostat 或 Cluster Cryostat 实例。
在 Provided APIs 部分中,提供 Cryostat 和 Cluster Cryostat 自定义资源(CR)。选择以下选项之一:
- 要创建单命名空间 Cryostat 实例,请选择 Cryostat,然后单击 Create instance。
- 要创建 Cryostat 的多命名空间实例,请选择 Cluster Cryostat,然后点 Create instance。
选择以下选项之一将 XML 格式的事件模板上传到资源中:
点 Form view 单选按钮。
- 导航到 Cryostat 或 Cluster Cryostat 实例的 Event Templates 部分。
- 在 Event Templates 菜单中点 Add Event Template。在 Red Hat OpenShift 控制台中打开一个 Event Templates 部分。
在 Config Map Name 下拉列表中选择包含您的事件模板的 ConfigMap 资源。
图 1.4. Cryostat 实例的 event Templates 选项
-
在 Filename 字段中,输入 ConfigMap 中包含的
.jfc
文件的名称。 - 要使用自定义事件模板生成 Cryostat 或 Cluster Cryostat 实例,请点 Create。
点 YAML 视图 单选按钮。
为
eventTemplates
属性指定任何自定义事件模板。此属性将 Red Hat build of Cryostat Operator 指向 ConfigMap,以便 Red Hat build of Cryostat Operator 可以读取事件模板。为
eventTemplates
属性指定自定义事件模板的示例-- apiVersion: operator.cryostat.io/v1beta1 kind: Cryostat metadata: name: cryostat-sample spec: eventTemplates: - configMapName: custom-template1 filename: my-template1.jfc - configMapName: custom-template2 filename: my-template2.jfc --
重要您必须从
configMapName
下拉列表中选择与 Cryostat 或 Cluster Cryostat 实例关联的 ConfigMap 名称。另外,您必须在filename
字段中指定与 ConfigMap 关联的键。Red Hat build of Cryostat Operator 现在可将自定义事件模板作为 XML 文件提供给您的 Cryostat 应用程序。您的自定义事件模板会与 Cryostat web 控制台中的默认事件模板一起打开。
验证
- 在 Cryostat web 控制台中,点菜单中的 Events。如果在 web 控制台中打开了一个 Authentication Required 窗口,请输入您的凭证并点 Save。
在 Event Templates 选项卡下,检查您的自定义事件模板是否在可用事件模板列表中显示。
图 1.5. 在 Event Templates 选项卡下列出的自定义事件模板示例
其他资源
- 请参阅使用 操作器在 OpenShift 上安装 Cryostat (Installing Cryostat)
- 请参阅使用 Web 控制台访问 Cryostat(Installing Cryostat)
- 请参阅使用自定义事件模板 (使用 Cryostat 管理 JFR 记录)