第2章 新機能

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

自動化ルールのユーザーコンソール (UI)

Cryostat 2.1 には、自動化ルール API 用のユーザーコンソール (UI) が追加されています。UI には次の主要な機能が含まれています。

JFR レコーディングへのメタデータとラベルの割り当て

Cryostat 2.1 で JFR レコーディングを作成する場合、キーと値のラベルのペアを持つメタデータをレコーディングに追加できます。さらに、ターゲット JVM 内にある JFR レコーディングにカスタムラベルを割り当てることができるため、JFR レコーディングを簡単に識別してより適切に管理できます。

メタデータとラベルの使用例としては、レコーディングに対するクエリーの実行やバッチ操作などがあります。Cryostat Web コンソールの Recordings メニューに移動して、JFR レコーディングのラベルとそのメタデータを編集できます。アーカイブにアップロードした JFR レコーディングのラベルとメタデータを編集することもできます。

クライアント側の通知の制御

Cryostat 2.1 は、発生する可能性のあるすべてのアクションと状態の変化に関する通知をブロードキャストするため、Cryostat Web クライアントに表示される通知の数が多くなります。その結果、Settings ページにクライアント側の通知を制御する機能が追加されました。

Cryostat 2.1 ユーザーは、カテゴリーごとに通知を有効または無効にしたり、すべてのグラフィック通知を一括で有効または無効にしたりできます。

Cryostat バックエンドは引き続き通知メッセージを送信し、Web クライアントはそれを受信します。通知を無効にすると、メッセージがコンソールに表示されなくなります。通知を再度有効にすると、以前の通知を閲覧できます。

カスタムリソース定義

Cryostat インスタンスのカスタムターゲットリソース定義を作成できるようになりました。これにより、Cryostat Operator は、Cryostat のデフォルトプロトコル以外の JMX プロトコルを使用してターゲットアプリケーションに接続できます。デフォルトのプロトコルは通常、JMX-RMI です。

カスタムターゲットリソース定義は YAML ファイルで設定されいます。定義には次の属性を指定できます。

カスタムターゲットオブジェクトの作成時に、Cryostat Operator はオブジェクトの RESTful API エンドポイント POST /api/v2/targets を使用します。オブジェクトが作成されると、REST HTTP API でオブジェクトの connectUrl を targetId URL パラメーターとして使用できます。

TargetDeleteHandler を使用して、Cryostat Operator からカスタムターゲットリソース定義を削除できます。このハンドラーは、DELETE/api/v2/targets/:connectUrl エンドポイント要求を読み取り、Cryostat Operator から定義を削除しようとします。

TargetsPostHandler と TargetDeleteHandler の両方に、ハンドラーが要求を処理できない場合に詳細なエラーメッセージを提供するコード化されたエラーメッセージが含まれています。

Cryostat Operator の環境変数

Cryostat 2.1 には、Cryostat Operator の動作を変更するために設定できる次の環境変数が組み込まれています。

JMC Agent プラグインのサポート

Cryostat 2.1 は、プローブテンプレートを管理する API ハンドラーのセットを使用することにより、JMC Agent プラグインをサポートします。

JMC Agent アプリケーションをインストールし、それをビルドして JAR ファイルを生成すると、JMC Agent プラグインを使用して Cryostat アプリケーションのエージェント機能にアクセスできます。このプラグインは、実行中のアプリケーションに JDK Flight Recorder (JFR) 機能を追加するなど、JMC エージェント機能を Cryostat インスタンスに提供します。

Cryostat 2.1 の Red Hat OpenShift 認証

Cryostat 2.1 は、Red Hat OpenShift のビルトイン OAuth サーバーをそのフレームワークに統合します。有効にすると、Red Hat OpenShift のユーザー名とパスワードを使用して Cryostat にログインできます。この統合された機能は、Cryostat 2.0 で提供されていたメカニズムよりも優れたメカニズムを提供します。Cryostat 2.0 では、Red Hat OpenShift Web コンソールから Red Hat OpenShift 認証トークンを手動でコピーし、コンソールの Cryostat Application URL セクションにトークンの詳細を貼り付ける必要がありました。

さらに、Red Hat OpenShift に割り当てられたロールベースアクセス制御 (RBAC) ロールを使用して Cryostat 機能へのアクセスを制限することもできます。

Cryostat 2.1 リリースには、GET /health 応答オブジェクトに以下のキーが含まれています。

Red Hat OpenShift 認証情報

Red Hat OpenShift Web コンソールから Cryostat 2.1 Web コンソールにログインすると、Cryostat Operator はセッション期間中に Red Hat OpenShift アカウントにユーザー名とパスワードの認証情報を一時的に保存します。これにより、Cryostat Web コンソールからログアウトする前に Cryostat Web コンソールセッションが終了するのを防ぐことができます。

Cryostat 2.1 での Java Management Extensions クレデンシャルの管理

コンテナー化された Java 仮想マシン (JVM) への認証に使用される Java Management Extension (JMX) クレデンシャルを保存および管理できます。この機能は、Cryostat に複数の JVM のクレデンシャルを記憶させ、再利用する場合に便利です。

JMX クレデンシャルを Cryostat に追加すると、クレデンシャルを表示できなくなります。これにより、Cryostat Web コンソールに入力した後はクレデンシャルが表示されなくなるため、クレデンシャルのセキュリティーが確保されます。クレデンシャルを置き換える場合は、クレデンシャルを削除して、再度追加する必要があります。

新しい自動化ルール環境変数

Cryostat 2.1 より前のバージョンでは、自動化ルールの JMX 接続が以前に Cryostat インスタンスのメモリーにキャッシュされていた場合、この JMX 接続は閉じられていました。この問題は、CRYOSTAT_TARGET_CACHE_MAX_CONNECTIONS 環境変数の動作が原因で発生しました。

Cryostat 2.1 の JMX キャッシュコンポーネントは、CRYOSTAT_TARGET_CACHE_MAX_CONNECTIONS 環境変数の代わりに CRYOSTAT_TARGET_CACHE_SIZE 環境変数を使用するようになりました。そのため、開いた JMX 接続が、自動化ルールによって Cryostat インスタンスのメモリーに自動的にキャッシュされなくなります。これにより、自動化ルールが原因でキャッシュストレージ領域がいっぱいになり、使用中の JMX 接続が閉じる問題を防止できます。この問題が発生すると、遅延と応答時間が長くなり、パフォーマンスが低下する可能性があります。

CRYOSTAT_TARGET_CACHE_SIZE 環境変数は、Cryostat インスタンスのメモリーにキャッシュする JMX 接続の最大数を指定します。この環境変数には、次の値を指定できます。

自動化ルールは、以前にキャッシュされた JMX 接続を再利用できます。JMX 接続が存在しない場合、Cryostat Operator は自動化ルール用の新しい JMX 接続を作成します。この接続はメモリーにキャッシュされません。

リソース要件

デフォルトでは、Cryostat Operator は、Red Hat OpenShift の Cryostat インスタンスのメイン Pod で動作する 3 つのコンテナーのそれぞれに対して、リソース要求や制限を指定せずに Cryostat アプリケーションをデプロイします。Cryostat 2.1 には、Cryostat カスタムリソース (CR) を使用して、次の 3 つのコンテナーのそれぞれにリソース要求または制限を指定できる機能があります。

サイドカーレポートコンテナー

Cryostat 2.1 では、サイドカーレポートコンテナーを使用して、JDK Fight Recordings (JFR) の自動分析レポートを生成できます。

Cryostat 2.1 より前のバージョンでは、メインの Cryostat コンテナーを使用して分析レポートを生成する必要がありました。このアプローチはリソースを大量に消費し、メインの Cryostat コンテナーに追加のリソースをプロビジョニングする必要がある場合があるため、Cryostat アプリケーションの実行パフォーマンスに影響を与える可能性があります。

サイドカーレポートコンテナーで分析レポートを生成することにより、Cryostat Operator を効率的に使用して、Cryostat アプリケーションのリソースをプロビジョニングできます。これにより、コンテナーと対話する Cryostat Operator が HTTP および JMC 接続を介したオーバーヘッドの少ない操作の実行に集中できるため、Cryostat コンテナーのリソースフットプリントが削減されます。

さらに、サイドカーレポートコンテナーを複製し、ニーズに合わせてこの複製を設定することもできます。