Merge branch 'master' into improve-doc-check

apache · Aug 21, 2024 · 350a6ff · 350a6ff
2 parents 5d51f30 + 4dceb42
commit 350a6ff
Show file tree

Hide file tree

Showing 5 changed files with 157 additions and 2 deletions.
diff --git a/home/docs/help/hive.md b/home/docs/help/hive.md
@@ -5,7 +5,7 @@ sidebar_label: Apache Hive
 keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache hive metrics]
 ---
 
-> Collect and monitor the general performance metrics exposed by the SpringBoot actuator.
+> Collect and monitor the general performance metrics exposed by the Apache Hive.
 
 ## Pre-monitoring operations
 

diff --git a/home/docs/help/iceberg.md b/home/docs/help/iceberg.md
@@ -0,0 +1,77 @@
+---
+id: iceberg 
+Title: Monitoring Apache Iceberg
+sidebar_label: Apache Iceberg
+keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache iceberg metrics]
+---
+
+> Collect and monitor the general performance metrics exposed by the Apache Iceberg.
+
+## Pre-monitoring operations
+
+If you want to monitor information in `Apache Iceberg` with this monitoring type, you need to open your `Hive Server2` in remoting mode.
+
+**1、Enable metastore:**
+
+```shell
+hive --service metastore &
+```
+
+**2. Enable hive server2:**
+
+```shell
+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 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              |
+
+### Collect metrics
+
+#### metric Collection: basic
+
+| Metric Name | metric unit |                   Metrics help describe                   |
+|-------------|-------------|-----------------------------------------------------------|
+| vm_name     | None        | The name of the virtual machine (VM) running HiveServer2. |
+| vm_vendor   | None        | The vendor or provider of the virtual machine.            |
+| vm_version  | None        | The version of the virtual machine.                       |
+| up_time     | None        | The duration for which HiveServer2 has been running.      |
+
+#### metric Collection: enviroment
+
+|     Metric Name      | metric unit |                       Metrics help describe                       |
+|----------------------|-------------|-------------------------------------------------------------------|
+| https_proxyPort      | None        | The port number used for HTTPS proxy communication.               |
+| os_name              | None        | The name of the operating system on which HiveServer2 is running. |
+| os_version           | None        | The version of the operating system.                              |
+| os_arch              | None        | The architecture of the operating system.                         |
+| java_runtime_name    | None        | The name of the Java runtime environment used by HiveServer2.     |
+| java_runtime_version | None        | The version of the Java runtime environment.                      |
+
+#### metric Collection: thread
+
+|     Metric Name      | metric unit |                        Metrics help describe                         |
+|----------------------|-------------|----------------------------------------------------------------------|
+| thread_count         | None        | The current number of threads being used by HiveServer2.             |
+| total_started_thread | None        | The total count of threads started by HiveServer2 since its launch.  |
+| peak_thread_count    | None        | The highest number of threads used by HiveServer2 at any given time. |
+| daemon_thread_count  | None        | The number of daemon threads currently active in HiveServer2.        |
+
+#### metric Collection: code_cache
+
+| Metric Name | metric unit |                          Metrics help describe                          |
+|-------------|-------------|-------------------------------------------------------------------------|
+| committed   | MB          | The amount of memory currently allocated for the memory pool.           |
+| init        | MB          | The initial amount of memory requested for the memory pool.             |
+| max         | MB          | The maximum amount of memory that can be allocated for the memory pool. |
+| used        | MB          | The amount of memory currently being used by the memory pool.           |
+
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
@@ -5,7 +5,7 @@ sidebar_label: Apache Hive
 keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hive 指标]
 ---
 
-> 收集和监控由 SpringBoot Actuator 提供的常规性能指标。
+> 收集和监控由 Apache Hive 提供的常规性能指标。
 
 ## 监控前操作
 

diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iceberg.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iceberg.md
@@ -0,0 +1,77 @@
+---
+id: iceberg
+Title: 监控 Apache Iceberg
+sidebar_label: Apache Iceberg
+keywords: [开源监控工具, 开源 Apache Iceberg 监控工具, 监控 Apache Iceberg 指标]
+---
+
+> 收集和监控由 Apache Iceberg 提供的常规性能指标。
+
+## 监控前操作
+
+如果您想使用此监控类型监控 Apache Iceberg 的信息，您需要以远程模式启动您的 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/sidebars.json b/home/sidebars.json
@@ -275,6 +275,7 @@
             "help/hdfs_datanode",
             "help/iotdb",
             "help/hive",
+            "help/iceberg",
             "help/airflow",
             "help/clickhouse",
             "help/elasticsearch",