在 Springboot Standalone 上管理 Fuse
前言 复制链接链接已复制到粘贴板!
Red Hat Fuse 提供两个企业监控工具来查看和管理 Fuse 集成:
- Fuse 控制台是一个基于 Web 的控制台,您可以从浏览器访问以监控和管理正在运行的 Fuse 容器。Fuse 控制台基于 Hawtio 开源软件(https://hawt.io/)。本指南介绍了如何使用 Fuse 控制台。
- Prometheus 为 Fuse 发行版存储系统和集成级别指标。您可以使用图形分析界面(如 Grafana)来查看和分析存储的历史数据。有关使用 Prometheus 的更多信息 ,请参阅 Prometheus 文档。
本指南的受众是关于 JBoss EAP 管理员的红帽 Fuse。本指南假定您熟悉红帽 Fuse 平台、Apache Camel 和组织处理要求。
使开源包含更多 复制链接链接已复制到粘贴板!
红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。我们从这四个术语开始:master、slave、黑名单和白名单。由于此项工作十分艰巨,这些更改将在即将推出的几个发行版本中逐步实施。详情请查看我们的 CTO Chris Wright 信息。
第 1 章 关于 Fuse 控制台 复制链接链接已复制到粘贴板!
Red Hat Fuse Console 是一个基于 HawtIO 开源软件的 Web 控制台。如需支持的浏览器列表,请转至 支持的配置。
Fuse 控制台提供了一个中央界面,用于检查和管理一个或多个部署的 Fuse 容器的详细信息。您还可以监控红帽 Fuse 和系统资源,执行更新,以及启动或停止服务。
当您安装红帽 Fuse 独立或在 OpenShift 中使用 Fuse 时,可以使用 Fuse 控制台。您可以在 Fuse 控制台中查看和管理的集成取决于正在运行的插件。可能的插件包括:
- Camel
- JMX
- OSGI
- Runtime
- 日志
第 2 章 访问 Spring Boot 2.x 的 Fuse 控制台 复制链接链接已复制到粘贴板!
您可以访问独立 Fuse Spring Boot 2.x 发行版的 Fuse 控制台。
流程
在您的 Fuse 应用程序的
pom.xml文件中添加以下依赖项:<dependency> <groupId>io.hawt</groupId> <artifactId>hawtio-springboot</artifactId> </dependency>
<dependency> <groupId>io.hawt</groupId> <artifactId>hawtio-springboot</artifactId> </dependency>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 请注意,您不需要指定确切的版本,因为它是由 Maven BOM 提供的。
编辑
src/main/resources/application.properties文件:设置以下属性:
-
management.endpoints.web.exposure.include=hawtio,jolokia -
hawtio.authenticationEnabled=false -
management.endpoint.hawtio.enabled=true -
management.endpoint.jolokia.enabled=true
-
另外,还可设置
management.endpoints.web.base-path属性。默认情况下,对于 Spring Boot 2.x,Fuse Console 的 URL 包含管理端点的上下文路径(
/actuator)。例如:http://localhost:10001/actuator/hawtio/index.html要更改这个默认 URL,例如指定
http://localhost:10001/hawtio,请设置management.endpoints.web.base-path属性,如下所示:management.endpoints.web.base-path=/您的
application.properties设置应类似以下示例:Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注意默认情况下,Spring Boot 上的 Fuse 控制台身份验证被禁用。另外,您还可以通过编写特定于 Fuse 控制台分发的代码来启用身份验证。以下是可用于指导的示例:
https://github.com/hawtio/hawtio/tree/master/examples/springboot-authentication
运行 Fuse 应用程序:
mvn spring-boot:run
mvn spring-boot:runCopy to Clipboard Copied! Toggle word wrap Toggle overflow 要确定 Fuse 控制台 URL 的端口号,请通过查看
src/main/resources/application.properties文件中设置的值来获取 management.server.port 值。例如:management.server.port = 10001
management.server.port = 10001Copy to Clipboard Copied! Toggle word wrap Toggle overflow 要在浏览器中打开 Fuse 控制台,请使用以下 URL 语法,其中 nnnnn 是 management.server.port 属性的值:
http://localhost:nnnnn/actuator/hawtio
例如,如果 management.server.port 属性值为
10001,并且您尚未设置management.endpoints.web.base-path属性,则 URL 为:
第 3 章 自定义 Fuse 控制台品牌 复制链接链接已复制到粘贴板!
您可以通过在 Spring Boot standalone 应用中添加 hawtconfig.json 文件来自定义 Fuse 控制台品牌信息,如标题、徽标和登录页面信息。
流程
-
在 Spring Boot standalone 应用的
src/main/webapp目录中,在本地 Fuse 中创建一个名为hawtconfig.json的 JSON 文件。 在您选择的编辑器中打开
src/main/webapp/hawtconfig.json,然后添加以下内容:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 更改 表 A.1 “Fuse 控制台配置属性” 中列出的配置属性的值。
- 保存您的更改。
使用以下命令在 Spring Boot 上运行 Fuse:
mvn spring-boot:run
mvn spring-boot:runCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
在网页浏览器中,使用此 URL 打开 Fuse 控制台
:http://localhost:10001/actuator/hawtio/index.html
如果您已在网页浏览器中运行 Fuse 控制台,则品牌将存储在浏览器的本地存储中。要使用新的品牌设置,您必须清除浏览器的本地存储。
第 4 章 保护 Fuse 控制台 复制链接链接已复制到粘贴板!
在 Spring Boot 上保护 Fuse 控制台:
在部署到 AWS 时禁用 Fuse 控制台代理 servlet
如果要将独立 Fuse 应用程序部署到 Amazon Web Services(AWS),您应该通过将
hawtio.disableProxy系统属性设置为true来禁用 Fuse Console 的代理 servlet。注意当您禁用 Fuse 控制台代理 servlet 时,Fuse Console 的 Connect 选项卡被禁用,您无法从 Fuse 控制台连接到其他 JVM。如果要在 AWS 上部署多个 Fuse 应用程序,则必须为每个应用程序部署 Fuse 控制台。
将 HTTPS 设置为所需协议
您可以使用
hawtio.http.strictTransportSecurity属性来要求 Web 浏览器使用安全 HTTPS 协议来访问 Fuse 控制台。此属性指定尝试使用 HTTP 访问 Fuse 控制台的 Web 浏览器必须自动转换请求以使用 HTTPS。使用公钥来保护响应
您可以使用
hawtio.http.publicKeyPins属性来确保 HTTPS 协议的安全,方法是指示 Web 浏览器将特定的加密密钥与 Fuse 控制台关联,以减少"man-in-the-the-the-the-the-middle"攻击的风险。
流程
设置
hawtio.http.strictTransportSecurity和hawtio.http.publicKeyPins属性,如下例所示:public static void main(String[] args) { System.setProperty("hawtio.http.strictTransportSecurity", "max-age=31536000; includeSubDomains; preload"); System.setProperty("hawtio.http.publicKeyPins", "pin-sha256=cUPcTAZWKaASuYWhhneDttWpY3oBAkE3h2+soZS7sWs"; max-age=5184000; includeSubDomains"); SpringApplication.run(YourSpringBootApplication.class, args); }public static void main(String[] args) { System.setProperty("hawtio.http.strictTransportSecurity", "max-age=31536000; includeSubDomains; preload"); System.setProperty("hawtio.http.publicKeyPins", "pin-sha256=cUPcTAZWKaASuYWhhneDttWpY3oBAkE3h2+soZS7sWs"; max-age=5184000; includeSubDomains"); SpringApplication.run(YourSpringBootApplication.class, args); }Copy to Clipboard Copied! Toggle word wrap Toggle overflow (仅用于在 AWS 上部署)要禁用 Fuse 控制台的代理 servlet,请设置
hawtio.disableProxy属性,如下例所示:public static void main(String[] args) { System.setProperty("hawtio.disableProxy", "true"); }public static void main(String[] args) { System.setProperty("hawtio.disableProxy", "true"); }Copy to Clipboard Copied! Toggle word wrap Toggle overflow
其他资源
-
有关
hawtio.http.strictTransportSecurity属性语法的描述,请查看 HTTP Strict Transport Security(HSTS) 响应标头的描述页。 -
有关
hawtio.http.publicKeyPins属性语法的描述,包括如何提取 Base64 编码公钥的说明,请参阅 HTTP Public Key Pinning 响应标头的描述页面。
第 5 章 确保数据在 Fuse 控制台中正确显示 复制链接链接已复制到粘贴板!
如果 Fuse Console 中的队列和连接缺少队列、缺失的连接或显示不一致的图标,请调整 Jolokia 集合大小参数,用于指定 Jolokia marls 中 Jolokia marls 的数组中的最大元素数量。
流程
在 Fuse 控制台右上角,单击用户图标,然后单击 首选项。
- 增加 Maximum collection size 选项的值(默认值为 50,000)。
- 单击 Close。
第 6 章 连接到远程 Fuse 应用程序 复制链接链接已复制到粘贴板!
Fuse 控制台使用 Jolokia,这是基于代理的方法,一种用于 Java 管理扩展(JMX)的方法,该方法需要在客户端上安装额外的软件(代理)。默认情况下,Red Hat Fuse 包含 jolokia 代理。
使用独立 Fuse 控制台发行版本,您可以连接到已在其内运行有 jolokia 代理(https://jolokia.org/)的远程集成。如果要连接到 的进程不在内没有 jolokia 代理,请参阅 jolokia 文档(http://jolokia.org/agent.html)。
流程
Fuse Console 的代理 servlet 使用白名单主机保护,默认情况下 Fuse 控制台只能连接到 localhost。如果要将 Fuse 控制台连接到其他远程 Fuse 实例,则需要在 Spring Boot 应用程序 的主() 方法中配置 hawtio.proxyWhitelist 系统属性:
System.setProperty("hawtio.proxyWhitelist", "localhost, 127.0.0.1, myhost1, myhost2, myhost3");
System.setProperty("hawtio.proxyWhitelist", "localhost, 127.0.0.1, myhost1, myhost2, myhost3");
6.1. 连接到远程 Jolokia 代理 复制链接链接已复制到粘贴板!
在开始之前,您需要了解远程 Jolokia 代理的连接详情(主机名、端口和路径)。
Spring Boot 上的 Jolokia 代理的默认连接 URL 是 http://<host>:8080/jolokia
作为系统管理员,您可以更改此默认值。
通常,远程连接到 Jolokia 代理的 URL 是打开 Fuse 控制台加上 /jolokia 的 URL。例如,如果打开 Fuse Console 的 URL 是 http://<host>:1234/hawtio,则要远程连接的 URL 可能是 http://<host>:1234/hawtio/jolokia。
连接到远程 Jolokia 实例,以便您可以检查其 JVM:
- 点 Connect 标签页。
- 点 Remote 选项卡,然后点 Add connection。
- 键入 名称、Scheme (HTTP 或 HTTPS) 和主机名。
- 单击 Test Connection。
- 点击 Add。
Fuse 控制台自动探测 localhost 和 127.0.0.1 以外的本地网络接口,并将它们添加到白名单中。因此,您不需要手动将本地机器的地址注册到白名单中。
6.2. 设置数据移动首选项 复制链接链接已复制到粘贴板!
例如,您可以更改以下 Jolokia 首选项,例如,如果您希望更频繁地刷新 Fuse Console 中显示的数据。请注意,增加数据更新的频率会影响网络流量,并增加向服务器发出的请求数量。
- 更新率 - 为 Jolokia 轮询到 Jolokia 之间的周期以获取 JMX 数据(默认为 5 秒)。
- 最大深度 - Jolokia 在返回前,到服务器端的 JSON 级别数量(默认为 7)。
- 最大集合大小 - 在响应中 Jolokia marshals 的数组的最大元素数(默认值为 50,000)。
要更改这些设置的值:
在 Fuse Console 右上角,单击用户图标,然后单击 首选项。
- 编辑选项,然后点击 Close。
6.3. 查看 JVM 运行时信息 复制链接链接已复制到粘贴板!
要查看 JVM 运行时信息,如系统属性、指标和线程,请单击 Runtime 选项卡。
第 7 章 查看并管理 Apache Camel 应用程序 复制链接链接已复制到粘贴板!
在 Fuse Console 的 Camel 选项卡中,您可以查看和管理 Apache Camel 上下文、路由和依赖项。
您可以查看以下详情:
- 所有正在运行的 Camel 上下文的列表
- 每个 Camel 上下文的详细信息,如 Camel 版本号和运行时静态
- 每个 Camel 应用程序中的所有路由列表及其运行时统计
- 运行的路由的图形表示以及实时指标
您还可以通过以下方式与 Camel 应用程序交互:
- 启动和暂停上下文
- 管理所有 Camel 应用程序及其路由的生命周期,以便您可以重新启动、停止、暂停、恢复等。
- 对正在运行的路由进行实时跟踪和调试
- 浏览和将消息发送到 Camel 端点
前提条件
只有在连接到使用一个或多个 Camel 路由的容器时,Camel 选项卡才可用。
7.1. 启动、挂起或删除上下文 复制链接链接已复制到粘贴板!
- 在 Camel 标签页的树视图中,单击 Camel 上下文。
- 选中列表中一个或多个上下文旁边的框。
- 点 Start 或 Suspend。
删除上下文:
- 停止上下文。
- 单击 ellipse 图标,然后从下拉菜单中选择 Delete。
当您删除上下文时,会从部署的应用程序中将其删除。
7.2. 查看 Camel 应用程序详情 复制链接链接已复制到粘贴板!
- 在 Camel 标签页的树视图中,点 Camel 应用程序。
- 若要查看应用属性和值的列表,请单击 Attributes。
- 要查看应用程序属性的图形表示,请点击 Chart,然后点 Edit 来选择要在 chart 中看到的属性。
- 要查看 inflight 和 blocked Exchanges,点 Exchanges。
- 要查看应用程序端点,请点击 Endpoints。您可以根据 URL、路由 ID 和 方向 过滤列表。
- 要查看、启用和禁用与 Camel 内置类型转换机制相关的统计信息,用于将消息正文和消息标头转换为不同的类型,请点击 Type Converters。
- 要查看并执行 JMX 操作,如从 XML 添加或更新路由或查找类路径中所有可用的 Camel 组件,请单击 运营。
7.3. 查看 Camel 路由列表并与之交互 复制链接链接已复制到粘贴板!
查看路由列表:
- 点 Camel 选项卡。
在 tree 视图中,点击应用程序的路由文件夹:
要启动、停止或删除一个或多个路由:
- 选中列表中一个或多个路由旁边的框。
- 点 Start 或 Stop。
要删除路由,您必须首先停止该路由。然后点击 ellipse 图标,然后从下拉菜单中选择 Delete。
注意- 当您删除路由时,您可以从部署的应用程序中将其删除。
- 您也可以在树视图中选择特定的路由,然后单击右上角菜单启动、停止或删除它。
- 要查看路由的图形图,请单击 Route 图表。
- 要查看 inflight 和 blocked Exchanges,点 Exchanges。
- 要查看端点,请单击 Endpoints。您可以根据 URL、Route ID 和方向过滤列表。
- 点 Type Converters 查看、启用和禁用与 Camel 内置类型转换机制相关的统计信息,该机制用于将消息正文和消息标头转换为不同的类型。
与特定路由交互:
- 在 Camel 标签页的树视图中,选择一个路由。
- 要查看路由属性和值的列表,请单击 Attributes。
- 要查看路由属性的图形表示,请点击 Chart。您可以点击 Edit 来选择要在 chart 中看到的属性。
- 要查看 inflight 和 blocked Exchanges,点 Exchanges。
- 点击 Operations 在路由上查看并执行 JMX 操作,如转储路由为 XML 或获取路由的 Camel ID 值。
跟踪通过路由的消息:
- 在 Camel 标签页的树视图中,选择一个路由。
- 选择 Trace,然后单击 Start tracing。
将信息发送到路由:
- 在 Camel 标签页的树视图中,打开上下文的端点文件夹,然后选择端点。
- 点 Send 子选项卡。
- 以 JSON 或 XML 格式配置消息。
- 点 Send。
- 返回路由的 Trace 选项卡,以查看通过路由的消息流。
7.4. 调试路由 复制链接链接已复制到粘贴板!
- 在 Camel 标签页的树视图中,选择一个路由。
- 选择 Debug,然后单击 Start debug。
要添加断点,请在图表中选择节点,然后点 Add breakpoint。一个红色点会出现在节点中:
节点添加到 breakpoints 列表中:
- 点击下箭头以向下一节点或 Play 按钮恢复运行路由。
- 单击 暂停 按钮,以暂停路由的所有线程。
- 完成后点 Stop debug。所有断点都会被清除。
第 8 章 查看并管理 JMX 域和 MBeans 复制链接链接已复制到粘贴板!
Java 管理扩展(JMX)是一种 Java 技术,可让您在运行时动态管理资源(服务、设备和应用程序)。资源由名为 MBeans(managed Bean)的对象表示。您可以在创建、实施或安装资源后立即管理和监控资源。
借助 Fuse 控制台上的 JMX 插件,您可以查看和管理 JMX 域和 MBeans。您可以查看 MBean 属性、运行命令并创建显示 MBeans 统计信息的 chart。
JMX 选项卡提供活动 JMX 域和 MBeans 在文件夹中组织的一个树视图。您可以查看 MBeans 的详细信息并执行命令。
流程
查看并编辑 MBean 属性:
- 在树视图中,选择一个 MBean。
- 单击 Attributes 选项卡。
- 点 属性查看其详情。
执行操作:
- 在树视图中,选择一个 MBean。
- 点 Operations 选项卡,展开列出的操作之一。
- 点 Execute 运行操作。
查看 chart:
- 在树视图中,选择一个项目。
- 点 Chart 选项卡。
第 9 章 查看并管理 Quartz 计划 复制链接链接已复制到粘贴板!
Quartz(http://www.quartz-scheduler.org/)是丰富的开源作业调度库,您可以在大多数 Java 应用程序中集成。您可以使用 Quartz 为执行作业创建简单或复杂的计划。作业定义为标准 Java 组件,可虚拟执行它要执行的操作。
如果您的 Camel 路由部署 camel-quartz2 组件,则 Fuse 控制台会显示 Quartz 选项卡。请注意,您可以通过 JMX 树视图来访问 Quartz mbeans。
流程
在 Fuse Console 中,单击 Quartz 选项卡。
Quartz 页面包含 Quartz Schedulers 和 Scheduler、Triggers 和 Jobs 选项卡的树状视图。
- 要暂停或启动调度程序,请单击 Scheduler 选项卡上的按钮。
点 Triggers 选项卡查看决定作业何时运行的触发器。例如,触发器可在某一天(到毫秒)时指定启动作业,也可以指定天数或在特定时间重复指定的次数。
- 要过滤触发器列表,请从下拉列表中选择 State、Group、Name 或 Type。然后,您可以通过在 fill-on 字段中选择或键入 来进一步过滤列表。
- 要暂停、恢复、更新或手动触发触发器,请单击 Action 列中的选项。
- 点 Jobs 标签页,查看正在运行的作业列表。您可以在表中对列表进行排序: Group、Name、Durable、Recover、Job ClassName 和 Description。
第 10 章 查看诊断 复制链接链接已复制到粘贴板!
使用 Diagnostics 选项卡,通过 JVM DiagnosticCommand 和 HotspotDiangostic 接口查看有关 JVM 的诊断信息。
这个功能类似于 Java Mission Control(jmc)或命令行工具 jcmd 中的 Diagnostic Commands 视图。该插件在某些情况下可以提供对应的 jcmd 命令。
流程
- 要检索载入类的实例数量及其所需字节数,请点击 Class Histogram。如果操作重复,则选项卡会显示自上次运行以来的区别。
- 若要查看 JVM 诊断标志设置,请单击 JVM 标志。
- 对于正在运行的 JVM,您还可以修改标志设置。
其他资源
支持的 JVM 依赖于平台,更多信息可进入以下源之一:
第 11 章 查看线程 复制链接链接已复制到粘贴板!
您可以查看和监控线程的状态。
流程
- 单击 Runtime 选项卡,然后单击 Threads 子选项卡。Threads 页面列出了活跃的线程和每个线程的堆栈追踪详情。默认情况下,线程列表以降序显示所有线程。
- 要通过增加 ID 对列表进行排序,点 ID 列标签。
- (可选)按线程状态(如 Blocked)或线程名称过滤列表。
- 要深入查看特定线程的详细信息,如锁定类名称和该线程的完整堆栈追踪,请点击 Actions 列中。
附录 A. Fuse 控制台配置属性 复制链接链接已复制到粘贴板!
默认情况下,Fuse 控制台配置在 hawtconfig.json 文件中定义。您可以自定义 Fuse 控制台配置信息,如标题、徽标和登录页面信息。
表 A.1 “Fuse 控制台配置属性” 提供属性的描述,并列出了每个属性是否需要值。
| 节 | 属性名称 | 默认值 | 描述 | 必需? |
|---|---|---|---|---|
| 关于 | 标题 | Red Hat Fuse Management Console | 在 Fuse Console 的 About 页面中显示的标题。 | 必填 |
| productInfo | 空值 | 有关 Fuse 控制台的 About 页面的产品信息。 | 选填 | |
| additionalInfo | 空值 | 在 Fuse Console 的 About 页面中显示任何其他信息。 | 选填 | |
| 版权 | 空值 | 在 Fuse Console 的 About 页面中显示版权信息。 | 选填 | |
| imgSrc |
| 出现在 Fuse 控制台的 About 页面中的镜像。 | 必填 | |
| 品牌 | appName | Red Hat Fuse Management Console | 应用程序的名称。此名称显示在 Fuse Console 的标题栏中。 | 必填 |
| appLogoUrl |
| 在 Fuse Console }navigation 栏中显示的应用程序徽标镜像文件的路径。该值可以是相对于 Hawtio 状态 URL 或绝对 URL 的路径。 | 必填 | |
| CSS | 外部 CSS 风格表的 URL,可用于编写应用程序。它可以是路径,相对于 Hawtio 状态 URL,也可以是一个绝对 URL。 | 选填 | ||
| companyLogoUrl |
| 您的公司徽标镜像文件的路径。 | 必填 | |
| Favicon | favicon 的 URL,通常显示在 Web 浏览器选项卡中。它可以是路径,相对于 Hawtio 状态 URL,也可以是一个绝对 URL。 | 选填 | ||
| login | description | 空值 |
在 Fuse 控制台登录页面中显示的描述性文本(例如 | 选填 |
| links | [ ] |
指定 | 选填 | |
| disabledRoutes | none | [ ] | 在控制台中禁用特定路径(如插件)。不要更改本节。OpenShift 以外的发行版本都不支持任何更改。 | 选填 |