Mention community project Broker for Nezha (#89)

This commit is contained in:
UUBulb
2024-08-13 13:55:04 +02:00
committed by GitHub
parent f02c88c0a3
commit b16ebc01e0
5 changed files with 82 additions and 2 deletions
+38
View File
@@ -0,0 +1,38 @@
# Broker for Nezha - Advancing on more platforms
Contributor:
+ [uubulb](https://github.com/uubulb)
Broker for Nezha is a modified version of the Nezha Agent that separates data collection from gRPC reporting, enabling small devices to connect to the Nezha Dashboard.
Project link: <https://github.com/uubulb/broker>
Online Documentation: [Broker for Nezha](https://broker.kuzu.uk/)
## Difference from Nezha Agent
- Utilizes external data sources to report to **Nezha Dashboard**.
- Supports configuring multiple sources and connecting to multiple Dashboards.
- Currently supports two task types only: `TaskTypeCommand` and `TaskTypeTerminalGRPC`, implemented using SSH. Other task types are not planned.
Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data acquisition methods:
1. HTTP (HTTP/1.1) - Active polling
2. TCP - Passive collection (recommended to avoid creating new connections)
For existing data collection software, refer to the project README. Due to security concerns, it's recommended to use this only in a trusted network.
## Writing a Data Collector
If you need to write your own data collector, you'll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: [Data types](https://broker.kuzu.uk/en/configuration/type/)
## Examples
<figure>
<img src="/images/case7/dashboard.jpg" alt="Dashboard">
<figcaption style="font-size: 0.9em; color: gray; text-align: center;">
Dashboard
</figcaption>
</figure>
<br />
<figure>
<img src="/images/case7/webssh.jpg" alt="WebSSH">
<figcaption style="font-size: 0.9em; color: gray; text-align: center;">
WebSSH
</figcaption>
</figure>