Red Hat build of Cryostat 2.2 のリリースノート

Red Hat は、Cryostat のメジャーバージョンを最低 6 カ月間サポートします。Red Hat は、製品が Red Hat カスタマーポータルでリリースされる時期に基づいてこの数値を定めています。

Cryostat は、x86_64 アーキテクチャーで実行される Red Hat OpenShift Container Platform 4.8 以降のバージョンにインストールしてデプロイできます。

Cryostat 2.2 では、Cryostat 製品の使用を強化する新機能が導入されています。

JFR レコーディングの自動アーカイブ

Cryostat 2.2 では、Archive on Stop チェックボックスが Recordings メニューに追加されたため、新しい JFR レコーディングを Red Hat OpenShift の永続ボリューム要求 (PVC) ストレージの場所に自動的にアーカイブするように Cryostat を設定できます。デフォルトでは、Archive on Stop チェックボックスはオンになっています。Continuous チェックボックスをオンにすると、Archive on Stop チェックボックスはオフになります。

さらに、CLI で curl コマンドを実行して、単一の JFR レコーディングを Red Hat OpenShift の PVC ストレージの場所に自動的にアーカイブするように Cryostat に要求することもできます。たとえば、次の curl コマンドは、指定された名前、期間、およびイベントテンプレートを持つ JFR レコーディングファイルを自動的にアーカイブするように Cryostat を指定します。

curl --data "recordingName=foo2&duration=5&events=template=ALL&archiveOnStop=true" localhost:8181/api/v1/targets/localhost/recordings

$ curl --data "recordingName=foo2&duration=5&events=template=ALL&archiveOnStop=true" localhost:8181/api/v1/targets/localhost/recordings

GraphQL API

Cryostat 2.2 には GraphQL API エンドポイント /api/v2.2/graphql が組み込まれています。これにより、API を使用してターゲット JVM に対してより短く、簡単なクエリーを実行できます。このクエリーは、ターゲット JVM のアクティブなレコーディングとアーカイブされたレコーディングに対しても実行できます。

API は、一般的な Cryostat アーカイブに対してクエリーを実行できます。その後、クエリーをカスタマイズして、アクティブまたはアーカイブされたレコーディングの以下のタスクを自動化できます。

Cryostat 2.2 では、次のクエリー機能が導入されています。

GraphQL API は、ワークロード機能が制限されている HTTP REST API よりも強力です。たとえば、HTTP REST API では、Red Hat OpenShift のコンテナー内にあるスケーリングされた各レプリカで起動するレコーディングのコピーごとに API 要求を作成する必要があります。GraphQL API は、1 つの API 要求でこのタスクを実現できます。これにより、API のパフォーマンスが向上し、Cryostat インスタンスのネットワークトラフィックを削減できます。

Cryostat 2.2 は HTTP REST API をサポートし、JWT トークンを使用して JFR ファイルをダウンロードする新しいエンドポイントなど、この API の機能拡張をいくつか備えています。ただし、この API には、より多くのユーザー介入が必要です。たとえば、応答データに対して反復操作を実行する場合、API JSON 応答を解析するカスタムクライアントを作成する必要があります。

Pluggable Discovery API

Cryostat は /api/v2.2/discovery エンドポイントをサポートしているため、Pluggable Discovery API を使用して外部クライアントを Cryostat に登録できます。

API は、Cryostat の環境に基づいてクライアントを登録または登録解除できます。

Cryostat のビルトインターゲット検出メカニズムを無効にすることで、Discovery Plugin API を Cryostat のプライマリーターゲット検出メカニズムとして使用できます。Cryostat のビルトイン検出メカニズムを無効にするには、次の環境変数を true に設定します。

CRYOSTAT_DISABLE_BUILTIN_DISCOVERY=true

CRYOSTAT_DISABLE_BUILTIN_DISCOVERY=true

Discovery Plugin API には、Cryostat のビルトインターゲット検出メカニズムのすべての機能が含まれています。

ConfigMap を使用したパーミッションマッピング

プロパティーファイルからの特定のパーミッションを含む ConfigMap リソースを作成できるようになりました。作成すると、Cryostat Operator が Cryostat インスタンスにパーミッションを適用できるようになります。Cryostat Operator が Cryostat にマウントするデフォルトのパーミッションファイルを使用する必要はなくなりました。

Cryostat CRD のセキュリティーコンテキスト

Red Hat OpenShift で Cryostat カスタムリソース (CRD) のセキュリティーコンテキストを指定できるようになりました。これにより、Cryostat Operator を設定して、Cryostat ワークロードを Red Hat OpenShift クラスター全体でより適切に分散できるようになりました。

Cryostat 2.2 より前のバージョンでは、Cryostat Operator はデフォルトのセキュリティーコンテキストを使用していました。これにより、Cryostat ワークロードを Red Hat OpenShift クラスター全体に分散するときに Cryostat Operator のパーミッションが制限されていました。

JSON での自動化ルール定義のアップロードのサポート

JSON で自動化ルール定義をアップロードすることにより、自動化ルールのルール定義を再利用できます。この機能は、レコーディングを Archives メニューにアップロードする方法と似ています。

Cryostat Web コンソールの Automated Rules メニューから、次のタスクを実行できるようになりました。

Cryostat 2.2 には、Cryostat 2.1 の機能に基づいて構築された機能拡張が含まれています。

JMX クレデンシャル変更後の自動化ルールの動作

Cryostat 2.2 より前のバージョンでは、Security メニューでアプリケーションの JMX クレデンシャルを入力する前にターゲット JVM アプリケーションを監視する自動化ルールを作成した場合、自動化ルールは警告なしで失敗していました。

Cryostat 2.2 ではこの問題が解決されています。今回の更新により、自動化ルールを作成した後に、問題なく JMX クレデンシャルを入力できるようになりました。アプリケーションの正しい JMX クレデンシャルを入力すると Cryostat が自動化ルールを再試行するため、自動化ルールを再作成する必要はありません。

Cryostat とターゲット JVM アプリケーションの間の接続を確立している間、Cryostat Operator は JMX クレデンシャルをメモリー内に保存します。Cryostat は、JMX クレデンシャルをデータベースに追加する HTTP リクエストと、そのクレデンシャルを使用してターゲットアプリケーションに接続する JMX 接続で SSL/TLS をサポートします。また、Cryostat は、ユーザーによって提供されたパスフレーズまたは Cryostat Operator によって生成されたパスフレーズを使用して、データベース内のクレデンシャルを暗号化します。

Cryostat Web コンソールの削除プロンプト

Cryostat 2.2 では、Cryostat Web コンソールの Delete 機能が更新されているため、Delete をクリックすると、Web コンソールに次のプロンプトが表示されます。

図3.1 Cryostat Web コンソールで開く Delete プロンプト

View larger image

Web コンソールで次のいずれかの削除操作を完了すると、このプロンプトにアクセスできます。

このプロンプトでは、レコーディングを削除すると、レコーディングに関連付けられたすべてのデータが削除されることが通知されます。

プロンプトには、次のオプションが表示されます。

いずれかのオプションをクリックすると、Cryostat は前のメニューに戻ります。

Edit Recording Labels ウィンドウ

Cryostat 2.2 では、Recordings メニューから Edit Metadata オプションが削除され、Active Recordings タブと Archived Recordings タブの下に Edit Labels ボタンが追加されます。

図3.2 Cryostat Web コンソールの Edit Recordings Labels ペイン

View larger image

Edit Labels ボタンをクリックすると、Cryostat Web コンソールで Editing Recordings Labels ペインが開きます。

Archives メニューの強化

Archives メニューでは、レコーディングが、ネストされた 3 つのテーブル (All Targets、All Archives、および Uploads) に分けられています。各テーブルには、時系列で結果がリストされます。

レコーディングをアーカイブした後、Cryostat は関連するターゲット JVM を All Targets テーブルに表示します。アーカイブされたレコーディングがないターゲット JVM エントリーを削除するには、Hide targets with zero recordings チェックボックスをクリックします。

JVM ターゲットエントリーの横にある下矢印アイコン (v) をクリックすると、フィルター機能にアクセスできます。この機能では、ラベルを編集してフィルターを強化したり、Delete ボタンをクリックしてフィルターを削除したりできます。

All Archives テーブルは All Targets テーブルに似ていますが、All Archives テーブルには、Cryostat がアーカイブしたファイルからのターゲット JVM アプリケーションがリスト表示されます。

Uploads テーブルでは、アップロードされたすべての JFR レコーディングを表示できます。Uploads テーブルには、All Targets テーブルと同様のフィルタリングメカニズムが組み込まれています。

Archives メニューのフィルタリングメカニズムを使用して、認識可能なターゲット JVM アプリケーションを持たない可能性があるアーカイブファイルを見つけることもできます。

Archive Recordings テーブルの問題を修正

Cryostat 2.2 では、Archive Recordings テーブルから重複ファイルの 1 つが削除されるという Cryostat 2.1 の問題が修正されています。この問題は、次の手順を完了すると発生します。

次のいずれかの操作を完了すると、ファイルが間違って削除されたことがわかる場合があります。

Cryostat 2.2 は、同じ名前の JFR レコーディングファイルを検出しても、各ファイルのターゲットが異なる場合、ファイルの 1 つを削除しません。この動作は、ターゲット JVM アプリケーションに属するアーカイブファイルと同じ名前のファイルを再アップロードする場合にも適用されます。

問題の原因の詳細は、重複したファイル名が Archived Recordings テーブルに表示される (Red Hat build of Cryostat 2.1 のリリースノート) を参照してください。

レコーディングのフィルタリング

Recordings メニューの Active Recordings タブまたは Archived Recordings タブから、各 JFR レコーディングエントリーの横に表示されるチェックボックスを選択して、リストされている JFR レコーディングをフィルタリングできます。

チェックボックスをクリックすると、Cryostat で Create、Archive、Edit Labels などのボタンが有効になります。

Cryostat のフィルタリング機能を使用すると、ターゲットの JFR レコーディングを正確に検索するフィルターを作成できます。

次の図は、3 つのアクティブなレコーディングがリストされた Active Recordings テーブルを示しています。

図3.3 3 つのアクティブなレコーディングがリストされた Active Recordings テーブルの例

View larger image

次の例は、template.type:TARGET ラベルと DurationSeconds: continuous ラベルの条件が定義されたフィルターを示しています。フィルタークエリーが完了すると、フィルターのラベル条件に一致する 2 つの結果が表示されます。

図3.4 Active Recordings タブにある完成したフィルターの例

View larger image

OpenJDK 17 および Eclipse Vert.x のサポート

Cryostat 2.2 は、Vert.x 4 フレームワークで構築されています。このフレームワークは、パフォーマンスを向上させ、従来のバグを修正し、Cryostat の新機能を構築します。

さらに、Cryostat 2.2 は OpenJDK 17 で構築されています。この OpenJDK の実装により、パフォーマンスが向上し、Cryostat のメモリー要件が軽減されます。

initialDelay 自動化ルールプロパティー

Cryostat 2.2 リリースより前のバージョンでは、レコーディングを Cryostat のアーカイブにコピーする自動化ルールを作成した場合、archivalPeriodSeconds プロパティーの値を指定してスケジュールを作成する必要がありました。この設定では、自動化ルールを使用しても、特定の時間間隔に基づいてレコーディングコピーをアーカイブに移動することしかできません。この archivalPeriodSeconds プロパティーを使用してアーカイブ期間をずらすことはできません。

Cryostat 2.2 には、ルール定義で定義できる initialDelay プロパティーが組み込まれています。これを定義すると、自動化ルールにより、必要に応じてアーカイブスケジュールをずらすことができます。たとえば、アプリケーション起動時にレコーディングをすぐにアーカイブする場合などが考えらえます。その後、アーカイブ間隔を 30 秒ごとにスケジュールできます。

Archived Recordings のテーブルを更新

Cryostat 2.2 は、Recordings メニューで開く Archived Recording テーブルを更新します。この表には、アーカイブされたファイルのサイズをキロバイト (KB) 単位で表示できる Size 列が含まれるようになりました。

さらに、このリリースでは、Archived Recording テーブルのスクロールバーを使用して、アーカイブされたファイルをすばやく見つけることができます。スクロールバーの表示は、テーブルの種類ごとに異なります。たとえば、Active Recordings テーブルでは、5 つ以上のアクティブな JFR レコーディングファイルがテーブルにリストされているときにスクロールバーにアクセスできます。

Cryostat 2.2 では、メンテナンスコストの高さ、コミュニティーの関心の低さ、より優れた代替ソリューションにより、一部の機能が削除されています。

OpenShift Operator CRD のサポートを削除

Cryostat 2.2 では、FlightRecorder または Recording カスタムリソース定義 (CRD) を使用できません。Cryostat には、OpenShift Operator の CRD と同じ機能を提供する HTTP REST API および GraphQL API が組み込まれています。さらに、Cryostat API には、これらの CRD よりも多くの機能が含まれています。

Cryostat のリリースには、Cryostat の以前のリリースで特定された問題の修正が含まれている場合があります。問題の説明とその後の修正については、修正された各問題の注記を確認してください。

Cryostat 2.2.1 で修正された問題

Cryostat 2.2.1 リリースで、次の問題が修正されました。

JMX セッションの正常な認証

Cryostat 2.2.1 より前のバージョンでは、Cryostat を JMX 経由でターゲット JVM アプリケーションに接続し、X-JMX-Authorization ヘッダーを介して JMX クレデンシャルを指定した場合に JMX クレデンシャルに失敗していました。今回の更新で、JMX クレデンシャルの失敗問題が解決され、JMX 経由で Cryostat をターゲット JVM アプリケーションに接続できるようになりました。

設定の変更に伴いデプロイメントの再作成を適用

Cryostat 2.2.1 より前のバージョンでは、Cryostat は設定に加えられた変更に応じてローリング更新を実行できませんでした。この問題は、新しい JMX クレデンシャルデータベースのロックファイルに競合があるために発生しました。今回の更新により、Cryostat はローリング更新を試行せず、代わりに設定に加えられた変更に応じてデプロイメントを再作成するようになりました。

Cryostat 2.2.0 で修正された問題

Cryostat 2.2.0 リリースで、次の問題が修正されました。

自動分析レポートの結果

Cryostat 2.2.0 より前のバージョンでは、Cryostat は停止した JFR レコーディングを反映するように分析レポートを更新しませんでした。次の一連の手順は、Cryostat の以前のバージョンでこの動作を再現する方法を示しています。

生成された最新のレポートには、停止したレコーディングではなく、最後のアクティブなレコーディングに基づくスナップショットの結果が表示されます。Cryostat は、停止したレコーディングのデータに基づいてレポートのコピーをキャッシュしません。そのため、最後のアクティブなレコーディングスナップショットに基づくレポートしか表示できません。

Cryostat 2.2.0 では、停止した JFR レコーディングからキャッシュされたデータに関するレポートを生成することで、この問題を修正しています。

レコーディングの Create ボタンのアクセスの問題を修正

Cryostat がターゲット JVM との接続を失い、この接続を再確立した後に、Cryostat が Recordings メニューの Create ボタンへのアクセスをブロックしたり、500 NoRouteToHost エラーメッセージを出力したりすることはなくなりました。

改訂日時: 2023-01-04 10:34:37 +1000