Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/.vuepress/sidebar/V1.2.x/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,6 @@ export const enSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
{ text: 'UDF Libraries', link: 'UDF-Libraries' },
{ text: 'Common Config Manual', link: 'Common-Config-Manual' },
{ text: 'Status Codes', link: 'Status-Codes' },
{ text: 'Keywords', link: 'Keywords' },
Expand Down
1 change: 0 additions & 1 deletion src/.vuepress/sidebar/V1.2.x/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,6 @@ export const zhSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
{ text: 'UDF函数库', link: 'UDF-Libraries' },
{ text: '配置参数', link: 'Common-Config-Manual' },
{ text: 'ConfigNode配置参数', link: 'ConfigNode-Config-Manual' },
{ text: 'DataNode配置参数', link: 'DataNode-Config-Manual' },
Expand Down
8 changes: 0 additions & 8 deletions src/.vuepress/sidebar/V1.3.x/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,6 @@ export const enSidebar = {
{ text: 'Apache Zeppelin', link: 'Zeppelin-IoTDB' },
{ text: 'Grafana', link: 'Grafana-Connector' },
{ text: 'Grafana Plugin', link: 'Grafana-Plugin' },
{ text: 'DataEase', link: 'DataEase' },
],
},
{
Expand All @@ -265,13 +264,6 @@ export const enSidebar = {
{ text: 'DBeaver', link: 'DBeaver' },
],
},
{
text: '‌IoT Platform',
collapsible: true,
children: [
{ text: 'ThingsBoard', link: 'Thingsboard' },
],
},
],
},
{
Expand Down
8 changes: 0 additions & 8 deletions src/.vuepress/sidebar/V1.3.x/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,6 @@ export const zhSidebar = {
{ text: 'Apache Zeppelin', link: 'Zeppelin-IoTDB_apache' },
{ text: 'Grafana', link: 'Grafana-Connector' },
{ text: 'Grafana插件', link: 'Grafana-Plugin' },
{ text: 'DataEase', link: 'DataEase' },
],
},
{
Expand All @@ -256,13 +255,6 @@ export const zhSidebar = {
{ text: 'DBeaver', link: 'DBeaver' },
],
},
{
text: '物联网平台',
collapsible: true,
children: [
{ text: 'ThingsBoard', link: 'Thingsboard' },
],
},
],
},
{
Expand Down
8 changes: 0 additions & 8 deletions src/.vuepress/sidebar/V2.0.x/en-Tree.ts
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,6 @@ export const enSidebar = {
{ text: 'Apache Zeppelin', link: 'Zeppelin-IoTDB' },
{ text: 'Grafana', link: 'Grafana-Connector' },
{ text: 'Grafana Plugin', link: 'Grafana-Plugin' },
{ text: 'DataEase', link: 'DataEase' },
],
},
{
Expand All @@ -259,13 +258,6 @@ export const enSidebar = {
{ text: 'DBeaver', link: 'DBeaver' },
],
},
{
text: '‌IoT Platform',
collapsible: true,
children: [
{ text: 'ThingsBoard', link: 'Thingsboard' },
],
},
],
},
{
Expand Down
8 changes: 0 additions & 8 deletions src/.vuepress/sidebar/V2.0.x/zh-Tree.ts
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,6 @@ export const zhSidebar = {
{ text: 'Apache Zeppelin', link: 'Zeppelin-IoTDB_apache' },
{ text: 'Grafana', link: 'Grafana-Connector' },
{ text: 'Grafana插件', link: 'Grafana-Plugin' },
{ text: 'DataEase', link: 'DataEase' },
],
},
{
Expand All @@ -250,13 +249,6 @@ export const zhSidebar = {
{ text: 'DBeaver', link: 'DBeaver' },
],
},
{
text: '物联网平台',
collapsible: true,
children: [
{ text: 'ThingsBoard', link: 'Thingsboard' },
],
},
],
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ To ensure the AINode installation package you obtained is complete and correct,

**Preparation:**

- Obtain the official SHA512 checksum: Please contact commercial support.
- Obtain the official SHA512 checksum.

**Verification Steps (using Linux as an example):**

Expand All @@ -77,7 +77,7 @@ To ensure the AINode installation package you obtained is complete and correct,

**Notes:**

- If the verification results do not match, please contact commercial support to obtain a new installation package.
- If the verification results do not match, please obtain a new installation package.
- If you encounter a "file not found" prompt during verification, check if the file path is correct or if the installation package was downloaded completely.

### 2.3 Environment Requirements
Expand Down Expand Up @@ -116,7 +116,7 @@ AINode supports modifying some necessary parameters. You can find the following
### 3.3 Importing Built-in Weight Files

*If the deployment environment has network connectivity and can access HuggingFace, the system will automatically pull the built-in model weight files. This step can be skipped.*
*For offline environments, contact commercial support to obtain the model weight folder and place it under the `/IOTDB_AINODE_HOME/data/ainode/models/builtin` directory.*
*For offline environments, prepare the model weight folder in advance and place it under the `/IOTDB_AINODE_HOME/data/ainode/models/builtin` directory.*
**NOTE:** Pay attention to the directory hierarchy. The parent directory for all built-in model weights should be `builtin`.

### 3.4 Starting AINode
Expand Down Expand Up @@ -228,7 +228,7 @@ If you need to upgrade the version of the current AINode, you can refer to the f

3. Update built-in model weights (optional)

* If the new version involves updates to built-in models, relevant information will be updated in the [Release History](../IoTDB-Introduction/Release-history_apache.md). You may contact commercial support to obtain the latest weight package and replace it in the `data/ainode/models/builtin` directory.
* If the new version involves updates to built-in models, relevant information will be updated in the [Release History](../IoTDB-Introduction/Release-history_apache.md). Prepare the latest weight package in advance and replace it in the `data/ainode/models/builtin` directory.

4. After the upgrade is completed, you can start the AINode service and check the node status. For specific commands, refer to Sections 3.4 and 3.5.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ AINode supports modifying some necessary parameters. You can find the following

> Offline environment only (Online environments can skip this step)
>
Contact commercial support to obtain the model weight files, then place them in the /IOTDB_AINODE_HOME/data/ainode/models/weights/ directory.
Prepare the model weight files in advance, then place them in the /IOTDB_AINODE_HOME/data/ainode/models/weights/ directory.

### 3.4 Start AINode

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@
<td>48core</td>
<td>1</td>
<td>2</td>
<td>Please contact commercial support for consultation</td>
<td>Evaluate as needed</td>
</tr>
<tr>
<td>Over 10000000</td>
<td colspan="4">Please contact commercial support for consultation</td>
<td colspan="4">Evaluate as needed</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -136,11 +136,11 @@
<td>128G</td>
<td>1</td>
<td>2</td>
<td>Please contact commercial support for consultation</td>
<td>Evaluate as needed</td>
</tr>
<tr>
<td>Over 10000000</td>
<td colspan="4">Please contact commercial support for consultation</td>
<td colspan="4">Evaluate as needed</td>
</tr>
</tbody>
</table>
Expand Down
88 changes: 0 additions & 88 deletions src/UserGuide/Master/Table/Tools-System/Monitor-Tool_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,91 +96,3 @@ For more details, refer to the following documents:
- [Prometheus Configuration for Pulling Metrics from HTTP Interface](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)
- [Grafana Installation and Usage Documentation](https://grafana.com/docs/grafana/latest/getting-started/getting-started/)
- [Grafana Querying Data from Prometheus and Plotting Documentation](https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus)

## 4. Apache IoTDB Dashboard

The `Apache IoTDB Dashboard` is a companion product of IoTDB, supporting unified centralized operation and maintenance management. It allows monitoring multiple clusters through a single monitoring panel. You can contact the business team to obtain the Dashboard's JSON file.

![Apache IoTDB Dashboard](/img/%E7%9B%91%E6%8E%A7%20default%20cluster.png)

![Apache IoTDB Dashboard](/img/%E7%9B%91%E6%8E%A7%20cluster2.png)

### 4.1 Cluster Overview

You can monitor, but not limited to:

- Total CPU cores, total memory space, total disk space of the cluster.
- Number of ConfigNodes and DataNodes in the cluster.
- Cluster uptime.
- Cluster write speed.
- Current CPU, memory, and disk usage of each node in the cluster.
- Node-specific information.

![](/img/%E7%9B%91%E6%8E%A7%20%E6%A6%82%E8%A7%88.png)

### 4.2 Data Writing

You can monitor, but not limited to:

- Average write latency, median latency, 99th percentile latency.
- Number and size of WAL files.
- Node WAL flush SyncBuffer latency.

![](/img/%E7%9B%91%E6%8E%A7%20%E5%86%99%E5%85%A5.png)

### 4.3 Data Query

You can monitor, but not limited to:

- Node query loading time series metadata latency.
- Node query reading time series latency.
- Node query modifying time series metadata latency.
- Node query loading Chunk metadata list latency.
- Node query modifying Chunk metadata latency.
- Node query filtering by Chunk metadata latency.
- Node query constructing Chunk Reader latency average.

![](/img/%E7%9B%91%E6%8E%A7%20%E6%9F%A5%E8%AF%A2.png)

### 4.4 Storage Engine

You can monitor, but not limited to:

- Number and size of files by type.
- Number and size of TsFiles in various stages.
- Number and latency of various tasks.

![](/img/%E7%9B%91%E6%8E%A7%20%E5%AD%98%E5%82%A8%E5%BC%95%E6%93%8E.png)

### 4.5 System Monitoring

You can monitor, but not limited to:

- System memory, swap memory, process memory.
- Disk space, file count, file size.
- JVM GC time ratio, GC count by type, GC data volume, heap memory usage by generation.
- Network transmission rate, packet sending rate.

![](/img/%E7%9B%91%E6%8E%A7%20%E7%B3%BB%E7%BB%9F%20%E5%86%85%E5%AD%98%E4%B8%8E%E7%A1%AC%E7%9B%98.png)

![](/img/%E7%9B%91%E6%8E%A7%20%E7%B3%BB%E7%BB%9Fjvm.png)

![](/img/%E7%9B%91%E6%8E%A7%20%E7%B3%BB%E7%BB%9F%20%E7%BD%91%E7%BB%9C.png)

### 4.6 Data Synchronization

Including but not limited to:

- Pipe event commit queue size, number of unassigned Pipe events
- Number of unprocessed events in the Source queue, Source event feeding rate, Processor event processing rate
- Number of untransmitted events for all Pipe Sinks/Sources, transmission event rate of Pipe connectors
- Retry queue size and pending handler count of Pipe Sinks; total data size before and after compression and compression duration of Pipe Sinks; batch size and batch interval distribution of Pipe Sinks
- Pipe memory usage and capacity, number of Pipe phantom references, quantity and total size of linked TsFiles, disk bytes read for TsFile transmission via Pipe

![](/img/monitor-tool-pipe-1-en.png)

![](/img/monitor-tool-pipe-2-en.png)

![](/img/monitor-tool-pipe-3-en.png)

![](/img/monitor-tool-pipe-4-en.png)
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ To ensure the AINode installation package you obtained is complete and correct,

**Preparation:**

- Obtain the official SHA512 checksum: Please contact commercial support.
- Obtain the official SHA512 checksum.

**Verification Steps (using Linux as an example):**

Expand All @@ -77,7 +77,7 @@ To ensure the AINode installation package you obtained is complete and correct,

**Notes:**

- If the verification results do not match, please contact commercial support to obtain a new installation package.
- If the verification results do not match, please obtain a new installation package.
- If you encounter a "file not found" prompt during verification, check if the file path is correct or if the installation package was downloaded completely.

### 2.3 Environment Requirements
Expand Down Expand Up @@ -116,7 +116,7 @@ AINode supports modifying some necessary parameters. You can find the following
### 3.3 Importing Built-in Weight Files

*If the deployment environment has network connectivity and can access HuggingFace, the system will automatically pull the built-in model weight files. This step can be skipped.*
*For offline environments, contact commercial support to obtain the model weight folder and place it under the `/IOTDB_AINODE_HOME/data/ainode/models/builtin` directory.*
*For offline environments, prepare the model weight folder in advance and place it under the `/IOTDB_AINODE_HOME/data/ainode/models/builtin` directory.*
**NOTE:** Pay attention to the directory hierarchy. The parent directory for all built-in model weights should be `builtin`.

### 3.4 Starting AINode
Expand Down Expand Up @@ -228,7 +228,7 @@ If you need to upgrade the version of the current AINode, you can refer to the f

3. Update built-in model weights (optional)

* If the new version involves updates to built-in models, relevant information will be updated in the [Release History](../IoTDB-Introduction/Release-history_apache.md). You may contact commercial support to obtain the latest weight package and replace it in the `data/ainode/models/builtin` directory.
* If the new version involves updates to built-in models, relevant information will be updated in the [Release History](../IoTDB-Introduction/Release-history_apache.md). Prepare the latest weight package in advance and replace it in the `data/ainode/models/builtin` directory.

4. After the upgrade is completed, you can start the AINode service and check the node status. For specific commands, refer to Sections 3.4 and 3.5.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ AINode supports modifying some necessary parameters. You can find the following

> Offline environment only (Online environments can skip this step)
>
Contact commercial support to obtain the model weight files, then place them in the /IOTDB_AINODE_HOME/data/ainode/models/weights/ directory.
Prepare the model weight files in advance, then place them in the /IOTDB_AINODE_HOME/data/ainode/models/weights/ directory.

### 3.4 Start AINode

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ You can use the `show cluster` command to view cluster information:

![](/img/%E5%BC%80%E6%BA%90%E7%89%88%20show%20cluter.png)

> The appearance of `ACTIVATED (W)` indicates passive activation, which means that this Configurable Node does not have a license file (or has not issued the latest license file with a timestamp), and its activation depends on other Activated Configurable Nodes in the cluster. At this point, it is recommended to check if the license file has been placed in the license folder. If not, please place the license file. If a license file already exists, it may be due to inconsistency between the license file of this node and the information of other nodes. Please contact commercial support to reapply.
> The appearance of `ACTIVATED (W)` indicates passive activation, which means that this Configurable Node does not have a license file (or has not issued the latest license file with a timestamp), and its activation depends on other Activated Configurable Nodes in the cluster. At this point, it is recommended to check if the license file has been placed in the license folder. If not, please place the license file. If a license file already exists, it may be due to inconsistency between the license file of this node and the information of other nodes. Please reapply.

### 3.6 One-click Cluster Start and Stop

Expand Down Expand Up @@ -500,8 +500,7 @@ For more details on cluster maintenance, please refer to: [Cluster Maintenance](

Step 1: Please check the startup log to see if any parameters that cannot be changed after the first startup have been modified.

Step 2: Please check the startup log for any other abnormalities. If there are any abnormal phenomena in the log, please contact commercial support for consultation on solutions.

Step 2: Please check the startup log for any other abnormalities.
Step 3: If it is the first deployment or data can be deleted, you can also clean up the environment according to the following steps, redeploy, and restart.

Step 4: Clean up the environment:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@
<td>48core</td>
<td>1</td>
<td>2</td>
<td>Please contact commercial support for consultation</td>
<td>Evaluate as needed</td>
</tr>
<tr>
<td>Over 10000000</td>
<td colspan="4">Please contact commercial support for consultation</td>
<td colspan="4">Evaluate as needed</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -137,11 +137,11 @@
<td>128G</td>
<td>1</td>
<td>2</td>
<td>Please contact commercial support for consultation</td>
<td>Evaluate as needed</td>
</tr>
<tr>
<td>Over 10000000</td>
<td colspan="4">Please contact commercial support for consultation</td>
<td colspan="4">Evaluate as needed</td>
</tr>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,16 +197,15 @@ When the status is all running, it indicates that the service has started succes

![](/img/%E5%BC%80%E6%BA%90-%E5%8D%95%E6%9C%BAshow.jpeg)

> The appearance of 'Activated (W)' indicates passive activation, indicating that this Config Node does not have a license file (or has not issued the latest license file with a timestamp). At this point, it is recommended to check if the license file has been placed in the license folder. If not, please place the license file. If a license file already exists, it may be due to inconsistency between the license file of this node and the information of other nodes. Please contact commercial support to reapply.
> The appearance of 'Activated (W)' indicates passive activation, indicating that this Config Node does not have a license file (or has not issued the latest license file with a timestamp). At this point, it is recommended to check if the license file has been placed in the license folder. If not, please place the license file. If a license file already exists, it may be due to inconsistency between the license file of this node and the information of other nodes. Please reapply.

## 3. Common Questions

1. Confignode failed to start

Step 1: Please check the startup log to see if any parameters that cannot be changed after the first startup have been modified.

Step 2: Please check the startup log for any other abnormalities. If there are any abnormal phenomena in the log, please contact commercial support for consultation on solutions.

Step 2: Please check the startup log for any other abnormalities.
Step 3: If it is the first deployment or data can be deleted, you can also clean up the environment according to the following steps, redeploy, and restart.

Step 4: Clean up the environment:
Expand Down
Loading
Loading