# 监控
本文介绍如何使用监控插件 (opens new window)。
# 功能介绍
监控插件用于监控宿主应用所在服务器的CPU、内存、磁盘IO和网络IO等硬件资源的使用情况，JVM资源使用情况比如堆内存使用、非堆内存使用、缓存区使用，吞吐量（QPS、TPS、平均响应时间）。监控插件依赖Prometheus进行指标收集，Prometheus会定期拉取监控插件采集的指标数据。
# 参数配置
# 插件配置
监控插件需要配置监控启用开关（monitor.config.enableStartService）、宿主应用所在环境的IP地址/域名（monitor.config.address）、宿主服务的端口（monitor.config.port）和上报方式（monitor.config.reportType）,可在${path}/sermant-agent-x.x.x/agent/pluginPackage/monitor/config/config.yaml找到该插件的配置文件， 配置如下所示：
monitor.config: # 监控插件配置。
enableStartService: false # 监控插件启动开关。为true时进行指标采集。
address: 127.0.0.1 # 宿主应用所在环境的IP地址/域名。创建服务器实例时使用。prometheus通过调用创建的服务器实例获取插件采集的指标信息。
port: 12345 # 对外提供Http服务的端口信息。创建服务器实例时使用。prometheus通过调用创建的服务器实例获取插件采集的指标信息。
reportType: PROMETHEUS # 监控指标上报方式。目前只支持PROMETHEUS。
userName: # 授权信息--授权用户名。配置授权信息后，prometheus也需要配置授权信息才能正常获取指标，防止恶意请求获取指标信息。
password: # 授权信息--授权用户密码--AES加密密文。配置授权信息后，prometheus也需要配置授权信息才能获取指标，防止恶意请求获取指标信息。
key: # 授权用户密码加密使用的KEY。
| 参数键 | 说明 | 默认值 | 是否必须 |
|---|---|---|---|
| monitor.config.enableStartService | 监控插件启动开关 | false | 是 |
| monitor.config.address | 宿主应用所在环境的IP地址/域名 | 127.0.0.1 | 是 |
| monitor.config.port | 对外提供Http服务的端口信息 | 12345 | 是 |
| monitor.config.reportType | 监控指标上报方式 目前只支持PROMETHEUS | PROMETHEUS | 是 |
| monitor.config.userName | 授权信息--授权用户名 | 空 | 否 |
| monitor.config.password | 授权信息--授权用户密码--AES加密 | 空 | 否 |
| monitor.config.key | 授权用户密码加密使用的KEY | 空 | 否 |
# 监控采集指标
监控插件目前能采集的指标数据如下表所示（对接prometheus之后用户可以通过指标名在prometheus查询具体的指标信息，参见验证)：
# 资源指标
| 指标名 | 说明 | 指标类型 |
|---|---|---|
| cpu_user | 用户态时间占比 | CPU |
| cpu_sys | 系统时间占比 | CPU |
| cpu_wait | 等待时间百分占比 | CPU |
| cpu_idle | 空闲时间占比 | CPU |
| cpu_cores | CPU物理核心数 | CPU |
| memory_total | 总内存大小 | memory |
| memory_swap | 缓存内存用的交换空间的大小 | memory |
| memory_cached | 缓存内存的物理内存总量 | memory |
| memory_buffer | 给文件做缓冲大小 | memory |
| memory_used | 已使用的内存大小 | memory |
| disk_readBytesPerSec | 采集周期内的磁盘每秒读字节数 | 磁盘IO |
| disk_writeBytesPerSec | 采集周期内的磁盘每秒写字节数 | 磁盘IO |
| disk_ioSpentPercentage | 采集周期内，磁盘IO花费的时间百分占比 | 磁盘IO |
| network_readBytesPerSec | 采集周期内的网络每秒读字节数 | 网络 |
| network_writeBytesPerSec | 采集周期内的网络每秒读字节数 | 网络 |
| network_readPackagePerSec | 采集周期内的网络每秒写字节数 | 网络 |
| network_writePackagePerSec | 采集周期内，网络IO花费的时间百分占比 | 网络 |
| heap_memory_init | 堆内存初始化值 | JVM |
| heap_memory_max | 堆内存最大值 | JVM |
| heap_memory_used | 堆内存已使用 | JVM |
| heap_memory_committed | 堆内存已提交 | JVM |
| non_heap_memory_init | 非堆内存初始化值 | JVM |
| non_heap_memory_max | 非堆内存最大值 | JVM |
| non_heap_memory_used | 非堆内存已使用值 | JVM |
| non_heap_memory_committed | 非堆内存已提交 | JVM |
| code_cache_init | 代码缓存区初始化值 | JVM |
| code_cache_max | 代码缓存区最大值 | JVM |
| code_cache_used | 代码缓存区已使用 | JVM |
| code_cache_committed | 代码缓存区已提交 | JVM |
| meta_sapce_init | 元空间初始化值 | JVM |
| meta_sapce_max | 元空间最大值 | JVM |
| meta_sapce_used | 元空间已使用值 | JVM |
| meta_sapce_committed | 元空间已提交值 | JVM |
| compressed_class_space_init | 压缩类空间初始化值 | JVM |
| compressed_class_space_max | 压缩类空间最大值 | JVM |
| compressed_class_space_used | 压缩类空间已使用值 | JVM |
| compressed_class_space_committed | 压缩类空间已提交值 | JVM |
| eden_init | eden区内存初始化值 | JVM |
| eden_max | eden区内存最大值 | JVM |
| eden_used | eden区内存已使用值 | JVM |
| eden_committed | eden区内存已提交值 | JVM |
| survivor_init | survivor区内存初始化值 | JVM |
| survivor_max | survivor区内存最大值 | JVM |
| survivor_used | survivor区内存已使用值 | JVM |
| survivor_committed | survivor区内存已提交值 | JVM |
| old_gen_init | 老年代内存初始化值 | JVM |
| old_gen_max | 老年代内存最大值 | JVM |
| old_gen_used | 老年代内存已使用值 | JVM |
| old_gen_committed | 老年代内存已提交值 | JVM |
| thread_live | 活动线程 | JVM |
| thread_peak | 线程峰值 | JVM |
| thread_daemon | 守护线程 | JVM |
| new_gen_count | 年轻代GC次数 | JVM |
| new_gen_spend | 年轻代GC耗时 | JVM |
| old_gen_count | 老年代GC次数 | JVM |
| old_gen_spend | 老年代GC耗时 | JVM |
| cpu_used | JVM占用CPU情况 | JVM |
| start_time | JVM已经启动时间，毫秒数 | JVM |
# 数据请求指标
| 指标名 | 说明 | 指标类型 |
|---|---|---|
| qps | 每秒请求数 | 吞吐量 |
| tps | 每秒请求处理数 | 吞吐量 |
| avg_response_time | 平均响应时间 | 吞吐量 |
# 熔断指标
| 指标名 | 说明 | 指标类型 |
|---|---|---|
| fused_request | 熔断的请求数量（触发熔断匹配规则的请求数量） | 熔断 |
| failure_fuse_request | 失败的请求数量（请求失败和忽略异常的请求数量） | 熔断 |
| failure_rate_fuse_request | 失败率 | 熔断 |
| avg_response_time | 平均响应时间 | 熔断 |
| qps | 每秒请求数 | 熔断 |
| tps | 每秒处理事务数 | 熔断 |
| slow_call_number | 慢调用数量 | 熔断 |
| permitted_fuse_request | 允许呼叫数 | 熔断 |
| buffered_calls_number | 缓存调用数量 | 熔断 |
| slow_call_failure_number | 慢调用失败数量 | 熔断 |
| successful_calls_number | 成功调用数量 | 熔断 |
| not_permitted_calls_number | 不允许呼叫数 | 熔断 |
| slow_call_success_number | 慢调用成功数量 | 熔断 |
# 支持版本与限制
框架支持：
- SpringBoot 1.5.10.Release及以上
- Dubbo 2.6.x-2.7.x
限制：
- 依赖Prometheus
- 服务器指标的采集依赖于Linux环境
# 操作和结果验证
下面将演示如何使用监控插件，验证springboot应用挂载监控插件对接Prometheus场景。
# 1 准备工作
- 下载 (opens new window) Demo二进制产物压缩包
- 下载 (opens new window) Sermant Release包（当前版本推荐2.1.0版本）
- 下载 (opens new window)Prometheus
注意：动态配置中心会在本场景中默认使用，由于非本场景的核心组件，因此在本文中不额外赘述。
# 2 获取Demo二进制产物
解压Demo二进制产物压缩包，即可得到monitor-demo.jar。
# 3 修改配置
- 修改监控插件配置，可在
${path}/sermant-agent-x.x.x/agent/pluginPackage/monitor/config/config.yaml找到该配置文件。
monitor.config: # 监控插件配置
enableStartService: true # 监控插件启动开关。修改为true。
address: 127.0.0.1 # 宿主应用所在环境的IP地址/域名。修改为宿主具体IP地址。
port: 12345 # 对外提供Http服务的端口信息。修改为可用的端口。
reportType: PROMETHEUS # 监控指标上报方式。目前只支持PROMETHEUS。
- 修改Prometheus (opens new window)的配置文件prometheus.yml。 在原有的作业信息下新增作业信息。
scrape_configs:
- job_name: "prometheus" # 作业名称。此为prometheus原有的任务。
static_configs:
- targets: ["localhost:9090"] # 监控主机地址
- job_name: "Sermant" # 作业名称。新增采集监控插件指标的作业
metrics_path: / # 采集指标的请求路径。默认为 /
basic_auth: # 采集指标的授权信息，与监控插件配置保持一致。监控插件未配置时可删除该配置。
username: # 采集指标的授权信息-用户名称
password: # 采集指标的授权信息-密码
static_configs:
- targets: ["127.0.0.1:12345"] # 采集指标的主机地址。此处的IP、端口信息与监控插件配置保持一致
# 4 启动应用
- 参考如下命令启动Demo应用
# Run under Linux
java -javaagent:${path}/sermant-agent-x.x.x/agent/sermant-agent.jar=appName=default -jar monitor-demo.jar
# Run under Windows
java -javaagent:${path}\sermant-agent-x.x.x\agent\sermant-agent.jar=appName=default -jar monitor-demo.jar
说明： ${path}为sermant实际安装路径，x.x.x代表sermant某个版本号。
- 启动 Prometheus
# 5 验证
打开Prometheus（默认为http://127.0.0.1:9090），查询指标。例如：查询heap_memory_used，能查询到信息则标示插件生效。
查询效果图如下所示：