HawtIO Diagnostic Console Guide

1. 在 settings.xml 文件中，为红帽 软件仓库 添加软件仓库元素，如下例所示：

   <?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. 为 pom.xml 中的依赖项添加 io.hawt:hawtio-quarkus 和支持 Camel Quarkus 扩展：

   <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 浏览器中的 OpenShift 控制台。
2. 点 Operators，然后点 OperatorHub。
3. 在搜索字段窗口中，键入 HawtIO 来过滤 Operator 列表。点 HawtIO Operator。

4. 在 HawtIO Operator 安装窗口中，点 Install。Create Operator Subscription 表单将打开：

   1. 对于 更新频道，请选择 stable-v1。

   2. 对于 Installation Mode，接受默认值（集群中的特定命名空间）。

      注意

      此模式决定了 Operator 将监控 HawtIO CR 的命名空间。这与命名空间 HawtIO 在被完全部署时监控的命名空间不同。后者可以通过 HawtIO CR 配置。

   3. 对于 Installed Namespace，选择要在其中安装 HawtIO Operator 的命名空间。

   4. 对于 Update Approval，选择 Automatic 或 Manual 来配置 OpenShift 如何处理对 HawtIO Operator 的更新。

      1. 如果选择了 Automatic updates 选项，并且有新版本的 HawtIO Operator 可用，OpenShift Operator Lifecycle Manager (OLM)将自动升级正在运行的 HawtIO 实例，而无需人为干预；
      2. 如果选择了 Manual 更新选项，且有新版本的 Operator 可用，OLM 只会创建一个更新请求。然后，集群管理员必须手动批准更新请求，才能将 HawtIO Operator 更新至新版本。
5. 点 Install 和 OpenShift 将 HawtIO Operator 安装到当前命名空间中。
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 （基于角色的访问控制），只有在 Config Map 字段中指定一个值，如果要自定义默认的 RBAC 行为，并且是否安装了 HawtIO Operator 的命名空间中已存在 ConfigMap 文件
      3. 对于 Nginx，请参阅 HawtIO Operator 安装的性能调优

      4. 对于 Type，指定：

         1. 集群 ：用于为任何支持 HawtIO 的应用程序监控 OpenShift 集群上的所有命名空间；
         2. 命名空间 : 用于仅监控在同一命名空间中部署的启用了 HawtIO 的应用程序。
   4. 点 Create。HawtIO Operator Details 页面将打开并显示部署的状态。

8. 打开 HawtIO ：

   1. 对于 命名空间 部署：在 OpenShift Web 控制台中，打开安装 HawtIO 操作器的项目，然后选择 Overview。在 Project Overview 页面中，向下滚动到 Launcher 部分，再单击 HawtIO 链接。
   2. 对于 集群部署，在 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，则用户会被限制掉 HawtIO 的 viewer 角色。用户可以在 HawtIO 中为 pod 执行只读 MBean 操作。

1. 在 Camel 选项卡的树视图中，单击 Camel Contexts。
2. 选中列表中一个或多个上下文旁边的框。
3. 点 Start 或 Suspend。

4. 删除上下文：

   1. 停止上下文。
   2. 单击 ellipse 图标，然后从下拉菜单中选择 Delete。

1. 在 Camel 选项卡的树视图中，点 Camel 应用程序。
2. 要查看应用属性和值的列表，请单击 Attributes。
3. 要查看应用程序属性的图形表示，请点 Chart，然后点 Edit 以选择要在图表中看到的属性。
4. 要查看动态和被阻止交换，请点击 Exchanges。
5. 要查看应用端点，请单击 Endpoints。您可以根据 URL、Route ID 和 方向 来过滤列表。
6. 要查看、启用和禁用与 Camel 内置类型转换机制相关的统计信息，用于将消息正文和消息标头转换为不同的类型，请单击 Type Converters。
7. 要查看和执行 JMX 操作，如从 XML 添加或更新路由或查找 classpath 中的所有 Camel 组件，请点 Operations。

1. 查看路由列表 ：

   1. 点 Camel 选项卡。

   2. 在树视图中，点应用程序的路由文件夹：

      

      View larger image

      

2. 启动、停止或删除一个或多个路由 ：

   1. 选中列表中一个或多个路由旁边的框。
   2. 点 Start 或 Stop。

   3. 要删除路由，您必须首先停止它。然后，单击 ellipse 图标，然后从下拉菜单中选择 删除。

      

      View larger image

      
      注意
      • 删除路由时，您可以将其从部署的应用程序中删除。
      • 您还可以在树视图中选择特定的路由，然后单击右上角的菜单来启动、停止或删除它。
3. 要查看路由的图形图，请点 Route 图表。
4. 要查看动态和被阻止交换，请点击 Exchanges。
5. 要查看端点，请点 Endpoints。您可以根据 URL、Route ID 和方向过滤列表。
6. 点 Type Converters 查看、启用和禁用与 Camel 内置类型转换机制相关的统计信息，该机制用于将消息正文和消息标头转换为不同的类型。

7. 与特定路由交互 ：

   1. 在 Camel 选项卡的树视图中，选择一个路由。要查看路由属性和值的列表，请单击 Attributes。
   2. 要查看路由属性的图形表示，请点 Chart。您可以点 Edit 来选择要在图表中看到的属性。
   3. 要查看动态和被阻止交换，请点击 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. 单击 暂停 按钮，以暂停路由的所有线程。
7. 完成后点 Stop debug。所有断点都被清除。