From b5e8963fa37ace28a53f309d60b25732c03ba1ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B7=9E=E7=AD=B1?= <105542329+a-little-fool@users.noreply.github.com> Date: Sun, 17 Dec 2023 21:17:32 +0800 Subject: [PATCH] [doc] add hive nginx pop3 spring_gateway zh-cn help doc (#1429) --- home/docs/help/hive.md | 18 +-- home/docs/help/spring_gateway.md | 2 +- .../current/help/hive.md | 77 ++++++++++++ .../current/help/nginx.md | 112 ++++++++++++++++++ .../current/help/pop3.md | 49 ++++++++ .../current/help/spring_gateway.md | 90 ++++++++++++++ 6 files changed, 338 insertions(+), 10 deletions(-) create mode 100644 home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md create mode 100644 home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md create mode 100644 home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md create mode 100644 home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md diff --git a/home/docs/help/hive.md b/home/docs/help/hive.md index aca4899573e..ec0d7dee398 100644 --- a/home/docs/help/hive.md +++ b/home/docs/help/hive.md @@ -16,7 +16,7 @@ If you want to monitor information in `Apache Hive` with this monitoring type, y ```shell hive --service metastore & ``` -**2. Enable hive server2** +**2. Enable hive server2:** ```shell hive --service hiveserver2 & @@ -24,15 +24,15 @@ hive --service hiveserver2 & ### Configure parameters -| Parameter name | Parameter Help describes the | -| ------------ |------------------------------------------------------| -| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). | -| Monitoring Name | A name that identifies this monitoring that needs to be unique. | -| Port | The default port provided by the database is 8080. | +| Parameter name | Parameter Help describes the | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------------| +| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). | +| Monitoring Name | A name that identifies this monitoring that needs to be unique. | +| Port | The default port provided by the database is 10002. | | Enable HTTPS | Whether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443 | -| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds | -| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful -| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here | +| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds | +| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful +| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here | ### Collect metrics diff --git a/home/docs/help/spring_gateway.md b/home/docs/help/spring_gateway.md index d384cc59b84..ae24228c222 100644 --- a/home/docs/help/spring_gateway.md +++ b/home/docs/help/spring_gateway.md @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, open source spring gateway monitoring to ## Pre-monitoring operations -If you want to monitor information in 'SpringBoot' with this monitoring type, you need to integrate your SpringBoot application and enable the SpringBoot Actuator. +If you want to monitor information in 'Spring Gateway' with this monitoring type, you need to integrate your SpringBoot application and enable the SpringBoot Actuator. **1、Add POM .XML dependencies:** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md new file mode 100644 index 00000000000..2c2136f91cf --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md @@ -0,0 +1,77 @@ +--- +id: hive +Title: 监控 Apache Hive +sidebar_label: Apache Hive +keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hive 指标] +--- + +> 收集和监控由 SpringBoot Actuator 提供的常规性能指标。 + +## 监控前操作 + +如果您想使用此监控类型监控 Apache Hive 的信息，您需要以远程模式启动您的 Hive Server2。 + +**1、启用元数据存储:** + +```shell +hive --service metastore & +``` +**2. 启用 Hive Server2:** + +```shell +hive --service hiveserver2 & +``` + +### 配置参数 + +| 参数名称 | 参数描述 | +| ---------- |--------------------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | +| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 10002。 | +| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | + +### 采集指标 + +#### 指标收集: 基本信息 + +| 指标名称 | 指标单位 | 指标描述 | +|--------|-------|-----------------------------| +| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机（VM）的名称。 | +| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 | +| 虚拟机版本 | 无 | 虚拟机的版本。 | +| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 | + +#### 指标收集: 环境信息 + +| 指标名称 | 指标单位 | 指标描述 | +|------------|-------|--------------------------------| +| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 | +| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 | +| 操作系统版本 | 无 | 操作系统的版本。 | +| 操作系统架构 | 无 | 操作系统的架构。 | +| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 | +| java运行环境版本 | 无 | Java 运行时环境的版本。 | + +#### 指标收集: 线程信息 + +| 指标名称 | 指标单位 | 指标描述 | +|--------|------|------------------------------| +| 线程数量 | None | HiveServer2 当前正在使用的线程数。 | +| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 | +| 最高线程数 | None | HiveServer2 在任何给定时间使用的最高线程数。 | +| 守护线程数 | None | HiveServer2 当前活动的守护线程数。 | + +#### 指标收集: 代码缓存 + +| 指标名称 | 指标单位 | 指标描述 | +|------------|-------------|---------------| +| 内存池当前内存 | MB | 当前为内存池分配的内存量。 | +| 内存池初始内存 | MB | 内存池请求的初始内存量。 | +| 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | +| 内存池内存使用量 | MB | 内存池已使用内存量 | + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md new file mode 100644 index 00000000000..39ddaa27e81 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md @@ -0,0 +1,112 @@ +--- +id: nginx +title: 监控 Nginx +sidebar_label: Nginx 监控 +keywords: [开源监控工具, 开源Java监控工具, 监控Nginx指标] +--- + +> 收集和监控 Nginx 的常规性能指标。 + +**使用的协议：Nginx** + +### 启用 Nginx 的 `ngx_http_stub_status_module` 和 `ngx_http_reqstat_module` 配置 + +如果你想使用这种监控方式监控 'Nginx' 的信息，你需要修改你的 Nginx 配置文件以启用监控模块。 + +**1、添加 ngx_http_stub_status_module 配置：** + +```shell +# modify nginx.conf +server { + listen 80; # port + server_name localhost; + location /nginx-status { + stub_status on; + access_log on; + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts + } +} +``` + + + +**2、添加 ngx_http_reqstat_module 配置：** + +```shell +# install `ngx_http_reqstat_module` +wget https://github.com/zls0424/ngx_req_status/archive/master.zip -O ngx_req_status.zip + +unzip ngx_req_status.zip + +patch -p1 < ../ngx_req_status-master/write_filter.patch + +./configure --prefix=/usr/local/nginx-1.4.2 --add-module=../ngx_req_status-master + +make -j2 + +make install +``` + +```shell +# modify nginx.conf +http { + req_status_zone server_name $server_name 256k; + req_status_zone server_addr $server_addr 256k; + req_status_zone server_url $server_name$uri 256k; + req_status server_name server_addr server_url; + server { + server_name xxx; // server_name + location /req-status { + req_status_show on; + } + } +} +``` + +**⚠️`ngx_http_reqstat_module` 需要自行下载安装，如果不需要监控该模块，只需收集 `ngx_http_stub_status_module` 模块的信息即可** + +**这里有帮助文档： https://blog.csdn.net/weixin_55985097/article/details/116722309** + + +### 配置参数 + +| 参数名 | 参数描述 | +|-------------------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | Nginx 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | + +### 收集指标 + +#### 指标收集：nginx_status + +| 指标名称 | 指标单位 | 指标描述 | +|-------|-------------|------------| +| 接收连接数 | | 已接受的连接 | +| 处理连接数 | | 成功处理的连接 | +| 活动连接数 | | 当前活动连接 | +| 丢弃连接数 | | 丢弃的连接 | +| 请求连接数 | | 客户端请求 | +| 读连接数 | | 正在执行读操作的连接 | +| 写连接数 | | 正在执行写操作的连接 | +| 等待连接数 | | 等待连接 | + +#### 指标集：req_status + +| 指标名称 | 指标单位 | 指标描述 | +|---------|-------|---------| +| 分组类别 | | 分组类别 | +| 分组名称 | | 分组名称 | +| 最大并发连接数 | | 最大并发连接数 | +| 最大带宽 | kb | 最大带宽 | +| 总流量 | kb | 总流量 | +| 总请求数 | | 总请求数 | +| 当前并发连接数 | | 当前并发连接数 | +| 当前带宽 | kb | 当前带宽 | + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md new file mode 100644 index 00000000000..8d6c2eb5548 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md @@ -0,0 +1,49 @@ +--- +id: pop3 +title: 监控POP3 +sidebar_label: POP3监控 +keywords: [开源监控工具，开源Java监控工具，监控POP3指标] +--- + +> 收集和监控POP3的常规性能指标。 + +**使用的协议：POP3** + +### 启用POP3服务 + +如果您想使用此监控类型来监控"POP3"的信息，请在您的邮件服务器上开启POP3服务。 + +**1、开启POP3服务：** + +```text +以qq邮箱为例【其它邮箱类似】： + 1. 点击`设置`选项 + 2. 选择`账号` + 3. 找到开启SMTP/POP3/IMAP选项，并开启 + 4. 得到POP3服务器域名，端口号，以及授权码【开启SMTP/POP3/IMAP服务后，qq邮箱提供】 + 5. 通过POP3服务器域名，端口号，qq邮箱账号以及授权码连接POP3服务器，采集监控指标 +``` + + +### 配置参数 + +| 参数名 | 参数描述 | +|-------------------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | POP3 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | + +### 采集指标 + +#### 指标集：email_status + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------| +| 邮件数量 | | 邮件数量 | +| 邮箱总大小 | kb | 邮箱中邮件的总大小 | + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md new file mode 100644 index 00000000000..086e0a63ac8 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md @@ -0,0 +1,90 @@ +--- +id: spring_gateway +Title: 监控 Spring Gateway +sidebar_label: Spring Gateway +keywords: [开源监控工具, 开源 Spring Gateway 监控工具, 监控 Spring Gateway 指标] +--- + +> 收集和监控 SpringBoot Actuator 提供的常规性能指标。 + +## 监控前操作 + +如果您想使用此监控类型监控 'Spring Gateway' 的信息，您需要集成您的 SpringBoot 应用程序并启用 SpringBoot Actuator。 + +**1、添加 POM .XML 依赖:** + +```xml + + org.springframework.boot + spring-boot-starter-actuator + +``` +**2. 修改 YML 配置以暴露度量接口:** + +```yaml +management: + endpoint: + gateway: + enabled: true # default value + endpoints: + web: + exposure: + include: '*' + enabled-by-default: on +``` + +### 配置参数 + +| 参数名称 | 参数描述 | +| ----------- |--------------------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | +| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 8080。 | +| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | will continue only if the probe is successful +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | + +### 采集指标 + +#### 指标收集: 健康状态 + +| 指标名称 | 指标单位 | 指标描述 | +|-------|-------|--------------------------| +| 服务状态 | 无 | 服务健康状态: UP（正常），Down（异常） | + +#### 指标收集: 环境信息 + +| 指标名称 | 指标单位 | 指标描述 | +|---------|-------|----------------------------------------------| +| profile | 无 | 应用程序运行的配置环境: prod（生产环境），dev（开发环境），test（测试环境） | +| 端口号 | 无 | 应用程序暴露的端口 | +| 操作系统 | 无 | 运行操作系统 | +| 操作系统架构 | 无 | 运行操作系统的架构 | +| JDK供应商 | 无 | JDK 供应商 | +| JVM版本 | 无 | JVM 版本 | + +#### 指标收集: 线程信息 + +| 指标名称 | 指标单位 | 指标描述 | +|-------------|------------|-------------| +| 状态 | 无 | 线程状态 | +| 数量 | 无 | 线程状态对应的线程数量 | + +#### 指标收集: 内存使用情况 + +| 指标名称 | 指标单位 | 指标描述 | +|-------|-------|-------------| +| 内存空间 | 无 | 内存空间名称 | +| 内存占用 | MB | 此空间占用的内存大小 | + +#### 指标收集: 路由信息 + +| 指标名称 | 指标单位 | 指标描述 | +|-------|-------|----------| +| 路由id | 无 | 路由 ID | +| 匹配规则 | 无 | 路由匹配规则 | +| 资源标识符 | 无 | 服务资源标识符 | +| 优先级 | 无 | 此路由的优先级 | + +