Skip to content

Commit 4dceb42

Browse files
Aias00Calvin979yuluo-yx
authored
[feature] add iceberg help md (apache#2573)
Co-authored-by: Calvin <[email protected]> Co-authored-by: YuLuo <[email protected]>
1 parent 1fac6ab commit 4dceb42

File tree

5 files changed

+157
-2
lines changed

5 files changed

+157
-2
lines changed

‎home/docs/help/hive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Apache Hive
55
keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache hive metrics]
66
---
77

8-
> Collect and monitor the general performance metrics exposed by the SpringBoot actuator.
8+
> Collect and monitor the general performance metrics exposed by the Apache Hive.
99
1010
## Pre-monitoring operations
1111

‎home/docs/help/iceberg.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
id: iceberg
3+
Title: Monitoring Apache Iceberg
4+
sidebar_label: Apache Iceberg
5+
keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache iceberg metrics]
6+
---
7+
8+
> Collect and monitor the general performance metrics exposed by the Apache Iceberg.
9+
10+
## Pre-monitoring operations
11+
12+
If you want to monitor information in `Apache Iceberg` with this monitoring type, you need to open your `Hive Server2` in remoting mode.
13+
14+
**1、Enable metastore:**
15+
16+
```shell
17+
hive --service metastore &
18+
```
19+
20+
**2. Enable hive server2:**
21+
22+
```shell
23+
hive --service hiveserver2 &
24+
```
25+
26+
### Configure parameters
27+
28+
| Parameter name | Parameter Help describes the |
29+
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
30+
| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). |
31+
| Monitoring Name | A name that identifies this monitoring that needs to be unique. |
32+
| Port | The default port provided by the database is 10002. |
33+
| 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 |
34+
| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds |
35+
| 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 |
36+
| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here |
37+
38+
### Collect metrics
39+
40+
#### metric Collection: basic
41+
42+
| Metric Name | metric unit | Metrics help describe |
43+
|-------------|-------------|-----------------------------------------------------------|
44+
| vm_name | None | The name of the virtual machine (VM) running HiveServer2. |
45+
| vm_vendor | None | The vendor or provider of the virtual machine. |
46+
| vm_version | None | The version of the virtual machine. |
47+
| up_time | None | The duration for which HiveServer2 has been running. |
48+
49+
#### metric Collection: enviroment
50+
51+
| Metric Name | metric unit | Metrics help describe |
52+
|----------------------|-------------|-------------------------------------------------------------------|
53+
| https_proxyPort | None | The port number used for HTTPS proxy communication. |
54+
| os_name | None | The name of the operating system on which HiveServer2 is running. |
55+
| os_version | None | The version of the operating system. |
56+
| os_arch | None | The architecture of the operating system. |
57+
| java_runtime_name | None | The name of the Java runtime environment used by HiveServer2. |
58+
| java_runtime_version | None | The version of the Java runtime environment. |
59+
60+
#### metric Collection: thread
61+
62+
| Metric Name | metric unit | Metrics help describe |
63+
|----------------------|-------------|----------------------------------------------------------------------|
64+
| thread_count | None | The current number of threads being used by HiveServer2. |
65+
| total_started_thread | None | The total count of threads started by HiveServer2 since its launch. |
66+
| peak_thread_count | None | The highest number of threads used by HiveServer2 at any given time. |
67+
| daemon_thread_count | None | The number of daemon threads currently active in HiveServer2. |
68+
69+
#### metric Collection: code_cache
70+
71+
| Metric Name | metric unit | Metrics help describe |
72+
|-------------|-------------|-------------------------------------------------------------------------|
73+
| committed | MB | The amount of memory currently allocated for the memory pool. |
74+
| init | MB | The initial amount of memory requested for the memory pool. |
75+
| max | MB | The maximum amount of memory that can be allocated for the memory pool. |
76+
| used | MB | The amount of memory currently being used by the memory pool. |
77+

‎home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Apache Hive
55
keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hive 指标]
66
---
77

8-
> 收集和监控由 SpringBoot Actuator 提供的常规性能指标。
8+
> 收集和监控由 Apache Hive 提供的常规性能指标。
99
1010
## 监控前操作
1111

‎home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iceberg.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
id: iceberg
3+
Title: 监控 Apache Iceberg
4+
sidebar_label: Apache Iceberg
5+
keywords: [开源监控工具, 开源 Apache Iceberg 监控工具, 监控 Apache Iceberg 指标]
6+
---
7+
8+
> 收集和监控由 Apache Iceberg 提供的常规性能指标。
9+
10+
## 监控前操作
11+
12+
如果您想使用此监控类型监控 Apache Iceberg 的信息，您需要以远程模式启动您的 Hive Server2。
13+
14+
**1、启用元数据存储:**
15+
16+
```shell
17+
hive --service metastore &
18+
```
19+
20+
**2. 启用 Hive Server2:**
21+
22+
```shell
23+
hive --service hiveserver2 &
24+
```
25+
26+
### 配置参数
27+
28+
| 参数名称 | 参数描述 |
29+
|----------|--------------------------------------------------------|
30+
| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 |
31+
| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 |
32+
| 端口 | 数据库提供的默认端口为 10002。 |
33+
| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 |
34+
| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 |
35+
| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 |
36+
| 描述备注 | 用于添加关于监控的额外标识和描述信息。 |
37+
38+
### 采集指标
39+
40+
#### 指标收集: 基本信息
41+
42+
| 指标名称 | 指标单位 | 指标描述 |
43+
|--------|------|-----------------------------|
44+
| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机（VM）的名称。 |
45+
| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 |
46+
| 虚拟机版本 | 无 | 虚拟机的版本。 |
47+
| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 |
48+
49+
#### 指标收集: 环境信息
50+
51+
| 指标名称 | 指标单位 | 指标描述 |
52+
|------------|------|--------------------------------|
53+
| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 |
54+
| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 |
55+
| 操作系统版本 | 无 | 操作系统的版本。 |
56+
| 操作系统架构 | 无 | 操作系统的架构。 |
57+
| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 |
58+
| java运行环境版本 | 无 | Java 运行时环境的版本。 |
59+
60+
#### 指标收集: 线程信息
61+
62+
| 指标名称 | 指标单位 | 指标描述 |
63+
|--------|------|------------------------------|
64+
| 线程数量 | None | HiveServer2 当前正在使用的线程数。 |
65+
| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 |
66+
| 最高线程数 | None | HiveServer2 在任何给定时间使用的最高线程数。 |
67+
| 守护线程数 | None | HiveServer2 当前活动的守护线程数。 |
68+
69+
#### 指标收集: 代码缓存
70+
71+
| 指标名称 | 指标单位 | 指标描述 |
72+
|------------|------|---------------|
73+
| 内存池当前内存 | MB | 当前为内存池分配的内存量。 |
74+
| 内存池初始内存 | MB | 内存池请求的初始内存量。 |
75+
| 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 |
76+
| 内存池内存使用量 | MB | 内存池已使用内存量 |
77+

‎home/sidebars.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,7 @@
275275
"help/hdfs_datanode",
276276
"help/iotdb",
277277
"help/hive",
278+
"help/iceberg",
278279
"help/airflow",
279280
"help/clickhouse",
280281
"help/elasticsearch",

0 commit comments

Comments
 (0)