Metrics插件
说明#
Metrics插件插件是网关用来监控自身运行状态（JVM相关），请求的响应迟延，QPS、TPS等相关metrics。
技术方案#
流程图
异步或者同步的方式，在
Apache ShenYu网关里面进行metrics埋点。prometheus服务端通过http请求来拉取metrics，再使用Grafana展示。
插件使用#
- 在网关的
pom.xml文件中添加metrics的依赖。
<!-- apache shenyu metrics plugin starter--> <dependency> <groupId>org.apache.shenyu</groupId> <artifactId>shenyu-spring-boot-starter-plugin-metrics</artifactId> <version>${project.version}</version> </dependency> <!-- apache shenyu metrics plugin end-->- 在网关的配置yaml文件中编辑如下内容：
shenyu: metrics: enabled: false #设置为 true 表示开启 name : prometheus host: 127.0.0.1 #暴露的ip port: 8090 #暴露的端口 jmxConfig: #jmx配置 props: jvm_enabled: true #开启jvm的监控指标metrics信息#
所有的
JVM，线程，内存，等相关信息都会埋点，可以在Grafana面板中，新增一个JVM模块，则会完全展示 具体请看：https://github.com/prometheus/jmx_exporter另外还有如下自定义的
metrics
| 名称 | 类型 | 标签名称 | 说明 |
|---|---|---|---|
| shenyu_request_total | Counter | none | collecting all requests of Apache ShenYu Gateway |
| shenyu_request_throw_total | Counter | none | collecting all exception requests of Apache ShenYu Gateway |
| shenyu_request_type_total | Counter | path,type | collecting all matched requests of monitor |
| shenyu_execute_latency_millis | histogram | none | ShenYu gateway execute time interval |
jmx 指标#
| name | type | labals | help |
|---|---|---|---|
| jmx_config_reload_success_total | counter | Number of times configuration have successfully been reloaded. | |
| jmx_config_reload_failure_total | counter | Number of times configuration have failed to be reloaded. | |
| jmx_scrape_duration_seconds | gauge | Time this JMX scrape took, in seconds. | |
| jmx_scrape_error | gauge | Non-zero if this scrape failed. | |
| jmx_scrape_cached_beans | gauge | Number of beans with their matching rule cached | |
| jmx_scrape_duration_seconds | gauge | Time this JMX scrape took, in seconds. | |
| jmx_scrape_error | gauge | Non-zero if this scrape failed. | |
| jmx_scrape_cached_beans | gauge | Number of beans with their matching rule cached |
jvm 指标#
StandardExports#
| name | type | labels | help |
|---|---|---|---|
| process_cpu_seconds_total | counter | Total user and system CPU time spent in seconds. | |
| process_start_time_seconds | gauge | Start time of the process since unix epoch in seconds. | |
| process_open_fds | gauge | Number of open file descriptors. | |
| process_max_fds | gauge | Maximum number of open file descriptors. | |
| process_virtual_memory_bytes | gauge | Virtual memory size in bytes. | |
| process_resident_memory_bytes | gauge | Resident memory size in bytes. |
MemoryPoolsExports#
| name | type | labels | help |
|---|---|---|---|
| jvm_memory_objects_pending_finalization | gauge | {area="heap|nonheap"} | The number of objects waiting in the finalizer queue. |
| jvm_memory_bytes_used | gauge | {area="heap|nonheap"} | Used bytes of a given JVM memory area. |
| jvm_memory_bytes_committed | gauge | {area="heap|nonheap"} | Committed (bytes) of a given JVM memory area. |
| jvm_memory_bytes_max | gauge | {area="heap|nonheap"} | Max (bytes) of a given JVM memory area. |
| jvm_memory_bytes_init | gauge | {area="heap|nonheap"} | Initial bytes of a given JVM memory area. |
| jvm_memory_pool_bytes_used | gauge | {pool} | Used bytes of a given JVM memory pool. |
| jvm_memory_pool_bytes_committed | gauge | {pool} | Committed bytes of a given JVM memory pool. |
| jvm_memory_pool_bytes_max | gauge | {pool} | Max bytes of a given JVM memory pool. |
| jvm_memory_pool_bytes_init | gauge | {pool} | Initial bytes of a given JVM memory pool. |
| jvm_memory_pool_collection_used_bytes | gauge | {pool} | Used bytes after last collection of a given JVM memory pool. |
| jvm_memory_pool_collection_committed_bytes | gauge | {pool} | Committed after last collection bytes of a given JVM memory pool. |
| jvm_memory_pool_collection_max_bytes | gauge | {pool} | Max bytes after last collection of a given JVM memory pool. |
| jvm_memory_pool_collection_init_bytes | gauge | {pool} | Initial after last collection bytes of a given JVM memory pool. |
MemoryAllocationExports#
| name | type | labels | help |
|---|---|---|---|
| jvm_memory_pool_allocated_bytes_total | counter | {pool} | Total bytes allocated in a given JVM memory pool. Only updated after GC, not continuously. |
BufferPoolsExports#
| name | type | labels | help |
|---|---|---|---|
| jvm_buffer_pool_used_bytes | gauge | {pool} | Used bytes of a given JVM buffer pool. |
| jvm_buffer_pool_capacity_bytes | gauge | {pool} | Bytes capacity of a given JVM buffer pool. |
| jvm_buffer_pool_used_buffers | gauge | {pool} | Used buffers of a given JVM buffer pool. |
GarbageCollectorExports#
| name | type | labels | help |
|---|---|---|---|
| jvm_gc_collection_seconds | summary | {gc} | Time spent in a given JVM garbage collector in seconds. |
ThreadExports#
| name | type | labels | help |
|---|---|---|---|
| jvm_threads_current | gauge | Current thread count of a JVM | |
| jvm_threads_daemon | gauge | Daemon thread count of a JVM | |
| jvm_threads_peak | gauge | Peak thread count of a JVM | |
| jvm_threads_started_total | counter | Started thread count of a JVM | |
| jvm_threads_deadlocked | gauge | Cycles of JVM-threads that are in deadlock waiting to acquire object monitors or ownable synchronizers | |
| jvm_threads_deadlocked_monitor | gauge | Cycles of JVM-threads that are in deadlock waiting to acquire object monitors | |
| jvm_threads_state | gauge | {state} | Current count of threads by state |
ClassLoadingExports#
| name | type | labels | help |
|---|---|---|---|
| jvm_classes_loaded | gauge | The number of classes that are currently loaded in the JVM | |
| jvm_classes_loaded_total | counter | The total number of classes that have been loaded since the JVM has started execution | |
| jvm_classes_unloaded_total | counter | The total number of classes that have been unloaded since the JVM has started execution |
VersionInfoExports#
| name | type | labels | help |
|---|---|---|---|
| jvm | info | {version(java.runtime.version),vendor(java.vm.vendor),runtime(java.runtime.name)} | VM version info |
收集 metrics#
用户需部署Prometheus 服务来采集
windows 环境下安装Prometheus#
选择对应环境的 下载地址安装
修改配置文件：
prometheus.ymlscrape_configs: - job_name: 'Apache ShenYu' # metrics_path defaults to '/metrics' # scheme defaults to 'http'. static_configs: - targets: ['localhost:8090'] # metrics of apache shenyu are exposed on port 8090 by default
注： job_name跟monitor插件配置的metricsName相对应
- 配置完成之后，在
windows下可以直接双击prometheus.exe启动即可，默认启动端口为9090，访问 http://localhost:9090/ ，点击status->Targets，验证是否成功。
macos 环境下安装Prometheus#
- 使用brew 安装 prometheus，安装完成后
prometheus在homebrew下的Cellar文件夹中。
brew install prometheus- 在prometheus.yml文件所在位置执行如下命令即可启动prometheus。
prometheus --config.file=prometheus.yml &访问 http://localhost:9090/ 验证是否正常启动。
下面介绍如何安装 Grafana
windows环境下安装Grafana#
- 安装
Grafana
下载地址 解压进入 bin 目录然后双击 grafana-server.exe 运行 访问 http://localhost:3000/?orgId=1 admin/admin 验证是否成功
macos环境下安装Grafana#
- 使用brew 安装 grafana 。
brew install grafana- 以服务方式启动grafana
brew services start grafana访问 http://localhost:3000/ 验证是否正常启动。
使用Grafana查看监控数据#
配置数据源，选择prometheus，注意数据源名字为prometheus。
- 配置自定义metric面板
request_total、http_request_total
点击 Create - Import 输入dashboards 的 面板json配置
最终自定义 Http 请求监控面板效果如下：
