Skip to content

Commit e3fcd36

Browse files
committed
add app: DataStorage
1 parent 7db5206 commit e3fcd36

File tree

3 files changed

+82
-0
lines changed

3 files changed

+82
-0
lines changed

directory.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -575,6 +575,10 @@
575575
{
576576
"title": "Monitor",
577577
"path": "configuration/north-apps/monitor/overview"
578+
},
579+
{
580+
"title": "DataStorage",
581+
"path": "configuration/north-apps/DataStorage/DataStorage"
578582
}
579583
]
580584
},
@@ -1291,6 +1295,10 @@
12911295
{
12921296
"title": "Monitor",
12931297
"path": "configuration/north-apps/monitor/overview"
1298+
},
1299+
{
1300+
"title": "DataStorage",
1301+
"path": "configuration/north-apps/DataStorage/DataStorage"
12941302
}
12951303
]
12961304
},
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# DataStorage
2+
3+
The Neuron DataStorage plugin is an open-source northbound plugin that writes data to [Datalayers](https://docs.datalayers.cn/datalayers/latest/) using [Arrow Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html#arrow-flight-sql). It extends Neuron's capability to store time-series data.
4+
5+
Upon startup, Neuron creates a singleton *DataStorage* node automatically. Users cannot manually create or delete this node.
6+
7+
You can view the *DataStorage* node in the **North Apps** tab throw the dashboard.
8+
9+
## Application Configuration
10+
11+
The following parameters are available when configuring the DataStorage node:
12+
13+
| Field | Description |
14+
| ------------------------------- | ------------------------------------------------------------ |
15+
| **Host** | IP address of the Datalayers server |
16+
| **Port** | gRPC service port of the Datalayers server |
17+
| **Username** | Datalayers username |
18+
| **Password** | Datalayers password |
19+
20+
:::tip
21+
When submitting the configuration, the connection to Datalayers will be verified, and if the connection fails, the configuration will be rejected.
22+
:::
23+
24+
## Add Subscription
25+
26+
After plugin configuration, data forwarding can be enabled via southbound device subscriptions.
27+
28+
Click the device card or row on the **North Apps** page, then **Add Subscription** on the **Group List** page. And set the following:
29+
30+
- **South device**: Select the southbound device you want to subscribe to.
31+
- **Group**: Select a group from the southbound device'.
32+
33+
## Data Upload
34+
35+
Neuron DataStorage uses Arrow's columnar format for data transmission, which eliminates serialization and deserialization during transport. This significantly reduces latency and performance overhead, improving system throughput.
36+
37+
## Operation & Maintenance
38+
39+
On the device card or device row, you can click on the **Data Statistics** icon to mreview the application's operation status and track the data received and sent.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# DataStorage
2+
3+
Neuron DataStorage 插件是一款开源的北向插件,使用 [Arrow Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html#arrow-flight-sql) 写入数据到 [Datalayers](https://docs.datalayers.cn/datalayers/latest/),它为 neuron 增加了时序数据的存储能力。
4+
5+
Neuron 会在启动时创建一个 *DataStorage* 单例节点,用户不能直接使用该插件创建或删除节点。
6+
您可以在仪表板的**北向应用**页签中看到 *DataStorage* 节点。
7+
8+
## 应用配置
9+
10+
以下是使用 DataStorage 插件配置节点时可用的参数:
11+
12+
| 字段 | 说明 |
13+
| ------------------------------- | ------------------------------------------------------------ |
14+
| **服务器地址** | Datalayers 服务器的 ip 地址 |
15+
| **服务器端口** | Datalayers gRPC 服务的端口 |
16+
| **用户名** | Datalayers 用户名 |
17+
| **密码** | Datalayers 密码 |
18+
19+
:::tip
20+
提交配置时,将验证与 Datalayers 的连接,如果连接失败,配置将被拒绝。
21+
:::
22+
23+
## 添加订阅
24+
25+
完成插件的添加和配置后,我们将继续通过订阅南向设备实现数据的转发。
26+
27+
完成设备配置后,在**北向应用**页,点击设备卡片/设备列进入**组列表**页。点击**添加订阅**,完成南向设备和组的设置。订阅完成后,DataStorage 节点将开始接收南向数据。
28+
29+
## 数据上传
30+
31+
Neuron DataStorage 在传输过程中使用 Arrow 的列存格式,在数据传输过程将完全避免序列化/反序列化操作,可彻底消除序列化/反序列化带来时间及性能损耗、提升系统的吞吐能力。
32+
33+
## 运行与维护
34+
35+
在设备卡片或设备列,您可点击数据统计图表查看及应用运行情况、接受和发送的数据情况。

0 commit comments

Comments
 (0)