Monitor插件

编辑
更新时间: 2021-04-17

说明

  • monitor插件是网关用来监控自身运行状态(JVM相关),请求的响应迟延,QPS、TPS等相关metrics。

技术方案

  • 流程图

  • 异步或者同步的方式,在soul网关里面进行 metrics 埋点。

  • prometheus 服务端通过 http 请求 来 拉取 metrics,再使用 Grafana 展示。

插件设置

  • soul-admin–> 插件管理-> monitor ,设置为开启。

  • 在 monitor 插件中新增以下配置

{"metricsName":"prometheus","host":"localhost","port":"9191","async":"true"}

# port : 为暴露给 prometheus服务来拉取的端口
# host : 不填写则为soul网关的host.
# async :"true" 为异步埋点, false 为同步埋点
  • 如果用户不使用,则在 soul-admin 后台把此插件停用。

插件使用

  • 在网关的 pom.xml 文件中添加 monitor 的支持。
  <!-- soul monitor plugin start-->
  <dependency>
      <groupId>org.dromara</groupId>
      <artifactId>soul-spring-boot-starter-plugin-monitor</artifactId>
      <version>${last.version}</version>
  </dependency>
  <!-- soul monitor plugin end-->
  • 选择器和规则,请详细看 : 选择器规则

    • 只有当匹配的url,才会进行url请求埋点。

metrics信息

  • 所有的JVM,线程,内存,等相关信息都会埋点,可以在 Granfana 面板中,新增一个 JVM 模块,则会完全展示 具体请看:https://github.com/prometheus/jmx_exporter

  • 另外还有如下自定义的 metrics

名称类型标签名称说明
request_totalCounter收集Soul网关所有的请求
http_request_totalCounterpath,type收集monitor插件匹配的请求

收集 metrics

用户需部署Prometheus 服务来采集

  • 选择对应环境的下载地址安装
  • 修改配置文件:prometheus.yml
 scrape_configs:
   # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
   - job_name: 'prometheus'
     # metrics_path defaults to '/metrics'
     # scheme defaults to 'http'.
     static_configs:
     - targets: ['localhost:9190']

注: job_namemonitor插件配置的metricsName相对应

  • 配置完成之后window下可以直接双击prometheus.exe启动即可,默认启动端口为9090,可通过http://localhost:9090/ 验证是否成功

面板展示

推荐使用 Grafana,用户可以自定义查询来个性化显示面板盘。

下面介绍Grafana部署(windows版)

  • 安装Grafana

下载地址 解压进入bin目录然后双击grafana-server.exe运行 访问http://localhost:3000/?orgId=1 admin/admin 验证是否成功

  • 配置Prometheus数据源

  • 配置JVM面板

点击Create - Import,输入dashboards的id(推荐8563)

最终JVM监控面板效果如下:

  • 配置自定义metric面板request_totalhttp_request_total

点击Create - Import,输入dashboards的面板json配置

最终自定义Http请求监控面板效果如下: