HawtIO 診断コンソールガイド

1. 以下の例のように、settings.xml ファイルに Red Hat リポジトリーの repository 要素を追加します。

   <?xml version="1.0"?>
   <settings>
   
     <profiles>
       <profile>
         <id>extra-repos</id>
         <activation>
           <activeByDefault>true</activeByDefault>
         </activation>
         <repositories>
          <repository>
            <id>redhat-ga-repository</id>
            <url>https://maven.repository.redhat.com/ga</url>
            <releases>
              <enabled>true</enabled>
            </releases>
            <snapshots>
              <enabled>false</enabled>
            </snapshots>
           </repository>
           <repository>
             <id>redhat-ea-repository</id>
             <url>https://maven.repository.redhat.com/earlyaccess/all</url>
             <releases>
               <enabled>true</enabled>
             </releases>
             <snapshots>
               <enabled>false</enabled>
             </snapshots>
           </repository>
         </repositories>
         <pluginRepositories>
           <pluginRepository>
             <id>redhat-ga-repository</id>
             <url>https://maven.repository.redhat.com/ga</url>
             <releases>
               <enabled>true</enabled>
             </releases>
             <snapshots>
               <enabled>false</enabled>
             </snapshots>
           </pluginRepository>
           <pluginRepository>
             <id>redhat-ea-repository</id>
             <url>https://maven.repository.redhat.com/earlyaccess/all</url>
             <releases>
               <enabled>true</enabled>
             </releases>
             <snapshots>
               <enabled>false</enabled>
             </snapshots>
           </pluginRepository>
         </pluginRepositories>
       </profile>
     </profiles>
   
     <activeProfiles>
       <activeProfile>extra-repos</activeProfile>
     </activeProfiles>
   
   </settings>

   Copy to Clipboard Toggle word wrap

手順:

1. jbang コマンドを使用して、最新の HawtIO をマシンにインストールします。

   $ jbang app install -Dhawtio.jbang.version=4.0.0.redhat-00040 hawtio@hawtio/hawtio

   Copy to Clipboard Toggle word wrap
   注記

   このインストール方法は、jbang>=0.115.0 でのみ利用できます。

2. HawtIO コマンドがインストールされます。次のコマンドを使用して HawtIO インスタンスを起動します。

   $ hawtio

   Copy to Clipboard Toggle word wrap

3. このコマンドにより、http://0.0.0.0:8080/hawtio/ のコンソールが自動的に開きます。ポート番号を変更するには、次のコマンドを実行します。

   $ hawtio --port 8090

   Copy to Clipboard Toggle word wrap

4. CLI の設定オプションの詳細を確認するには、次のコードを実行してください。

   $ hawtio --help
   Usage: hawtio [-hjoV] [-c=<contextPath>] [-d=<plugins>] [-e=<extraClassPath>]
                 [-H=<host>] [-k=<keyStore>] [-l=<warLocation>] [-p=<port>]
                 [-s=<keyStorePass>] [-w=<war>]
   Run Hawtio
     -c, --context-path=<contextPath>
                         Context path.
     -d, --plugins-dir=<plugins>
                         Directory to search for .war files to install as 3rd
                           party plugins.
     -e, --extra-class-path=<extraClassPath>
                         Extra class path.
     -h, --help          Print usage help and exit.
     -H, --host=<host>   Hostname to listen to.
     -j, --join          Join server thread.
     -k, --key-store=<keyStore>
                         JKS keyStore with the keys for https.
     -l, --war-location=<warLocation>
                         Directory to search for .war files.
     -o, --open-url      Open the web console automatic in the web browser.
     -p, --port=<port>   Port number.
     -s, --key-store-pass=<keyStorePass>
                         Password for the JKS keyStore with the keys for https.
     -V, --version       Print Hawtio version
     -w, --war=<war>     War file or directory of the hawtio web application.

   Copy to Clipboard Toggle word wrap

手順:

1. io.hawt:hawtio-quarkus およびサポートする Camel Quarkus エクステンションを pom.xml の依存関係に追加します。

   <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>io.hawt</groupId>
         <artifactId>hawtio-bom</artifactId>
         <version>4.0.0.redhat-00040</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
     </dependencies>
     <!-- ... other BOMs or dependencies ... -->
   </dependencyManagement>
   
   <dependencies>
     <dependency>
       <groupId>io.hawt</groupId>
       <artifactId>hawtio-quarkus</artifactId>
     </dependency>
   
      <!-- Mandatory for enabling Camel management via JMX / Hawtio -->
     <dependency>
       <groupId>org.apache.camel.quarkus</groupId>
       <artifactId>camel-management-starter</artifactId>
     </dependency>
   
     <!-- (Optional) Required for Hawtio Camel route diagram tab -->
     <dependency>
       <groupId>org.apache.camel.quarkus</groupId>
       <artifactId>camel-quarkus-jaxb</artifactId>
     </dependency>
   
     <!-- ... other dependencies ... -->
   </dependencies>

   Copy to Clipboard Toggle word wrap

2. 以下のように、開発モードで Quarkus アプリケーションを使用して HawtIO を実行します。

   mvn compile quarkus:dev

   Copy to Clipboard Toggle word wrap
3. http://localhost:8080/hawtio を開き、HawtIO コンソールを表示します。

手順:

1. io.hawt:hawtio-springboot およびサポートする Camel Spring Boot スターターを pom.xml の依存関係に追加します。

   <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>io.hawt</groupId>
         <artifactId>hawtio-bom</artifactId>
         <version>4.0.0.redhat-00040</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
       <!-- ... other BOMs or dependencies ... -->
     </dependencies>
   </dependencyManagement>
   
   <dependencies>
     <dependency>
       <groupId>io.hawt</groupId>
       <artifactId>hawtio-springboot</artifactId>
     </dependency>
   
      <!-- Mandatory for enabling Camel management via JMX / Hawtio -->
     <dependency>
       <groupId>org.apache.camel.springboot</groupId>
       <artifactId>camel-management-starter</artifactId>
     </dependency>
   
     <!-- (Optional) Required for Hawtio Camel route diagram tab -->
     <dependency>
       <groupId>org.apache.camel.springboot</groupId>
       <artifactId>camel-spring-boot-xml-starter</artifactId>
     </dependency>
   
     <!-- ... other dependencies ... -->
   </dependencies>

   Copy to Clipboard Toggle word wrap

2. 次の行を application.properties に追加して、HawtIO および Jolokia エンドポイントを有効にします。

   spring.jmx.enabled = true
   management.endpoints.web.exposure.include = hawtio,jolokia

   Copy to Clipboard Toggle word wrap

3. 次のように、Spring Boot アプリケーションを開発モードで使用して HawtIO を実行します。

   mvn spring-boot:run

   Copy to Clipboard Toggle word wrap
4. http://localhost:8080/actuator/hawtio を開き、HawtIO コンソールを表示します。

1. Web ブラウザーで、cluster admin 権限を持つユーザーとして OpenShift コンソールにログインします。
2. Operators をクリックした後、OperatorHub をクリックします。
3. 検索フィールドウィンドウで HawtIO と入力し、演算子の一覧をフィルタリングします。HawtIO Operator をクリックします。

4. HawtIO Operator インストールウィンドウで、Install をクリックします。Create Operator Subscription フォームが表示されます。

   1. Update Channel の場合は、stable-v1 を選択します。

   2. Installation Mode では、デフォルト (クラスターの特定の namespace) を受け入れます。

      注記

      このモードは、Operator が HawtIO CR を監視する名前空間を決定します。これは、完全にデプロイされるときに HawtIO が監視する名前空間とは異なります。後者は HawtIO CR で設定できます。

   3. Installed Namespace の場合は、HawtIO Operator をインストールする namespace を選択します。

   4. Update Approval では、Automatic または Manual を選択し、HawtIO Operator の更新が OpenShift によってどのように対処されるかを設定します。

      1. Automatic 更新オプションが選択され、新しいバージョンの HawtIO Operator が利用可能な場合、OpenShift Operator Lifecycle Manager (OLM)は人の介入なしに、HawtIO の実行中のインスタンスを自動的にアップグレードします。
      2. Manual updates オプションが選択され、Operator の新しいバージョンが利用可能な場合、OLM は更新要求のみを作成します。次に、クラスター管理者は更新リクエストを手動で承認して、HawtIO Operator を新しいバージョンに更新する必要があります。
5. Install and OpenShift install HawtIO Operator を現在の namespace にインストールします。
6. インストールを確認するには、Operators をクリックした後、Installed Operators をクリックします。hawtio は演算子のリストに表示されるはずです。

7. OpenShift Web コンソールを使用して HawtIO をデプロイするには、以下を実行します。

   1. Installed Operators のリストで、Name 列の下にある HawtIO Operator をクリックします。
   2. Provided APIs の Operator Details ページで、Create HawtIO をクリックします。

   3. 設定のデフォルト値を使用するか、任意でデフォルト値を編集します。

      1. Replicas の場合、HawtIO のパフォーマンスを向上させるには（高可用性環境など）、HawtIO に割り当てられる Pod の数を増やすことができます。
      2. RBAC (ロールベースアクセス制御) では、デフォルトの RBAC 動作をカスタマイズする場合や、HawtIO Operator をインストールした namespace に ConfigMap ファイルがすでに存在する場合にのみ、Config Map フィールドに値を指定します。
      3. Nginx については、HawtIO Operator インストールのパフォーマンスチューニング を参照してください。

      4. Type には、以下のいずれかを指定します。

         1. クラスター: HawtIO が HawtIO 対応アプリケーションについて OpenShift クラスター上のすべての namespace を監視する場合。
         2. 名前空間: HawtIO が、同じ名前空間にデプロイされた HawtIO 対応アプリケーションのみを監視する場合。
   4. Create をクリックします。HawtIO Operator Details ページが開き、デプロイメントのステータスが表示されます。

8. HawtIO を開くには、以下を実行します。

   1. namespace デプロイメントの場合：OpenShift Web コンソールで、HawtIO Operator がインストールされているプロジェクトを開き、Overview を選択します。Project Overview ページで Launcher セクションまで下方向にスクロールし、HawtIO リンクをクリックします。
   2. cluster デプロイメントでは、OpenShift Web コンソールのタイトルバーで、グリッドアイコンをクリックします。ポップアップメニューの Red Hat Applications で、HawtIO URL リンクをクリックします。
   3. HawtIO にログインします。ブラウザーに Authorize Access ページが表示され、必要なパーミッションが表示されます。
   4. Allow selected permissions をクリックします。hawtio がブラウザーで開き、アクセスが許可される HawtIO 対応アプリケーション Pod が表示されます。
9. Connect をクリックして監視対象のアプリケーションを表示します。新しいブラウザーウィンドウが開き、アプリケーションが HawtIO に表示されます。

1. Admin : ユーザーが OpenShift で Pod を更新できる場合、ユーザーには HawtIO の admin ロールが付与されます。ユーザーは、HawtIO で Pod の 書き込み MBean 操作を実行できます。
2. viewer: ユーザーが OpenShift で Pod を get できる場合、ユーザーには HawtIO の viewer ロールが付与されます。ユーザーは、HawtIO で Pod の読み取り専用 MBean 操作を実行できます。

1. Camel タブのツリービューで、Camel Contexts をクリックします。
2. リストのコンテキストの横にあるボックスにチェックマークを入れます。
3. Start または Suspend をクリックします。

4. コンテキストを削除するには以下を行います。

   1. コンテキストを停止します。
   2. 楕円のアイコンをクリックし、ドロップダウンメニューで Delete を選択します。

1. Camel タブのツリービューで、Camel アプリケーションをクリックします。
2. アプリケーションの属性と値のリストを表示するには、Attributes をクリックします。
3. アプリケーション属性をグラフィカルに表示するには、Chart をクリックした後、Edit をクリックし、チャートに表示する属性を選択します。
4. inflight exchange および blocked exchange を表示するには、Exchanges をクリックします。
5. アプリケーションエンドポイントを表示するには、Endpoints をクリックします。リストは URL、Route ID、および direction で絞り込むことができます。
6. メッセージ本文とメッセージヘッダーを別のタイプに変換するために使用される Camel 組み込みタイプ変換メカニズムに関連する統計を表示、有効化、および無効化するには、Type Converters をクリックします。
7. JMX 操作 (XML からのルートの追加または更新、クラスパスで利用できる Camel コンポーネントの検索など) を表示および実行するには、Operations をクリックします。

1. ルートのリストを表示するには、以下を行います。

   1. Camel タブをクリックします。

   2. ツリービューでアプリケーションの routes フォルダーをクリックします。

      

      View larger image

      

2. 1 つまたは複数のルートを起動、停止、または削除するには、以下を行います。

   1. リストのルートの横にあるボックスにチェックマークを入れます。
   2. Start または Stop をクリックします。

   3. 最初にルートを停止してから削除する必要があります。停止したら楕円のアイコンをクリックし、ドロップダウンメニューで Delete を選択します。

      

      View larger image

      
      注記
      • ルートを削除する場合、デプロイされたアプリケーションから削除します。
      • ツリービューで特定のルートを選択し、右上のメニューをクリックして起動、停止、または削除することもできます。
3. ルートのグラフィカルな図を表示するには、Route Diagram をクリックします。
4. inflight exchange および blocked exchange を表示するには、Exchanges をクリックします。
5. エンドポイントを表示するには、Endpoints をクリックします。URL、Route ID、および方向でリストを絞り込むことができます。
6. Type Converters をクリックし、Camel の組み込みタイプ変換メカニズムに関連する統計を表示、有効化、および無効化します。このメカニズムはメッセージ本文とメッセージヘッダーを別のタイプに変換するために使用されます。

7. 特定のルートと対話するには、以下を行います。。

   1. Camel タブのツリービューで、ルートを選択します。ルート属性と値のリストを表示するには、Attributes をクリックします。
   2. ルート属性をグラフィカルに表示するには、Chart をクリックします。Edit をクリックすると、チャートに表示する属性を選択できます。
   3. inflight exchange および blocked exchange を表示するには、Exchanges をクリックします。
   4. Operations をクリックして JMX 操作 (ルートを XML としてダンプ、ルートの Camel ID 値の取得など) を表示および実行できます。

8. ルートを介してメッセージをトレースするには、以下を実行します。

   1. Camel タブのツリービューで、ルートを選択します。
   2. Trace を選択し、Start tracing をクリックします。

9. メッセージをルートに送信するには、以下を行います。

   1. Camel タブのツリービューでコンテキストのエンドポイントフォルダーを開き、エンドポイントを選択します。
   2. Send サブタブをクリックします。
   3. JSON または XML 形式のメッセージを設定します。
   4. Send をクリックします。
   5. ルートの Trace タブに戻り、ルートを介したメッセージのフローを確認します。

1. Camel タブのツリービューで、ルートを選択します。
2. Debug を選択し、Start debugging をクリックします。

3. ブレークポイントを追加するには、図のノードを選択し、Add breakpoint をクリックします。ノードに赤い点が表示されます。

   

   View larger image

   

4. ノードがブレークポイントのリストに追加されます。

   

   View larger image

   

5. 下矢印をクリックして次のノードに移動するか、Resume ボタンをクリックしてルートの実行を再開します。

   

   View larger image

   
6. Pause ボタンをクリックして、ルートのすべてのスレッドを一時停止します。
7. 終了したら Stop debugging をクリックします。すべてのブレークポイントが消去されます。