文档

暴露 Prometheus 指标

更新时间:

本文介绍如何通过 Prometheus 暴露 RPC 的监控指标。

前提条件

使用的 SOFABoot 版本大于等于 3.10.3。

配置方法

  1. 在引入了 SOFARPC 的项目中添加以下依赖:

    重要

    不要配置版本,版本由 dependencyManagement 控制。

    <dependency>
     <groupId>io.micrometer</groupId>
     <artifactId>micrometer-registry-prometheus</artifactId>
    </dependency>

    加入上述依赖,RPC 会自动激活 Prometheus 指标。

  2. application.properties文件中添加以下配置暴露 Actuator 的 Prometheus 端点。

    management.endpoints.web.exposure.include=prometheus,<Other endpoints>

启动项目后,您就可以通过 Actuator 访问到 Prometheus 监控指标,其中将包含 SOFARPC 的监控指标。

如果您执行以上操作后未达成目标,建议您执行以下操作:

  • 检查项目中是否引入了 spring-boot-starter-actuator。如果没有,请手动添加。

  • 检查项目中引入的开源版 SOFARPC 版本是否大于 5.9.1。如果小于该版本,请修改或删除对 SOFARPC 版本的控制。

    说明

    SOFABoot 3.10.3 所引入的开源版 SOFARPC 版本为 5.11.1。