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 ページの Details タブで、Cryostat または Cluster Cryostat インスタンスを作成します。
Provided APIs セクションで、Cryostat および Cluster Cryostat カスタムリソース (CR) が利用可能です。以下のオプションのいずれかを選択します。
- 単一 namespace の Cryostat インスタンスを作成するには、Cryostat を選択してから Create instance をクリックします。
- 複数 namespace の 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 インスタンスのイベントテンプレートオプション
-
Filename フィールドに、ConfigMap に含まれている
.jfc
ファイルの名前を入力します。 - カスタムイベントテンプレートを使用して Cryostat または Cluster Cryostat インスタンスを生成するには、Create をクリックします。
YAML view のラジオボタンをクリックします。
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 タブにリストされているカスタムイベントテンプレートの例
関連情報
- Operator を使用して OpenShift に Cryostat をインストールする (Cryostat のインストール) を参照してください。
- Web コンソールを使用した Cryostat へのアクセス (Cryostat のインストール) を参照してください。
- カスタムイベントテンプレートの使用 (Cryostat を使用した JFR 記録の管理) を参照してください。