@oisasoje/gloo-receiver 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
A lightweight, high-performance telemetry receiver and WebSocket broadcaster server for Gloo request tracing.
|
|
4
4
|
|
|
5
|
-
It listens on port `7777` by default
|
|
5
|
+
It listens on port `7777` by default, hosting the visualizer dashboard UI and accepting request trace payloads from the `@oisasoje/gloo` SDK to stream them in real time.
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -15,18 +15,20 @@ It listens on port `7777` by default. It accepts request trace payloads from the
|
|
|
15
15
|
|
|
16
16
|
---
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Internal Component
|
|
19
19
|
|
|
20
|
-
You do not need to install
|
|
20
|
+
This package is the internal telemetry engine for the Gloo system. **You do not need to install or run it directly.**
|
|
21
|
+
|
|
22
|
+
Instead, use the [Gloo CLI](https://www.npmjs.com/package/@oisasoje/gloo-cli) to start the entire visualizer suite:
|
|
21
23
|
|
|
22
24
|
```bash
|
|
23
|
-
|
|
25
|
+
npm install -g @oisasoje/gloo-cli
|
|
26
|
+
gloo dev
|
|
24
27
|
```
|
|
25
28
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
http://localhost:7777
|
|
29
|
-
```
|
|
29
|
+
When started via the CLI, the receiver:
|
|
30
|
+
1. Ingests traces on `http://localhost:7777/trace`.
|
|
31
|
+
2. Hosts the visualizer dashboard UI directly on `http://localhost:7777`.
|
|
30
32
|
|
|
31
33
|
---
|
|
32
34
|
|
|
@@ -42,6 +44,9 @@ The receiver exposes a simplified REST API for trace ingestion and management:
|
|
|
42
44
|
| `DELETE` | `/traces` | Clears all stored traces in-memory and syncs visualizers. |
|
|
43
45
|
| `DELETE` | `/traces/:id` | Deletes a single trace by UUID and syncs visualizers. |
|
|
44
46
|
|
|
47
|
+
> [!NOTE]
|
|
48
|
+
> All other frontend assets (such as HTML, JS, CSS) are served by the receiver from its internal static `out/` directory, with SPA fallback routing.
|
|
49
|
+
|
|
45
50
|
---
|
|
46
51
|
|
|
47
52
|
## WebSocket Stream Protocol
|
|
@@ -66,11 +71,15 @@ All messages sent over the WebSocket follow this envelope structure:
|
|
|
66
71
|
## Architecture (v1)
|
|
67
72
|
|
|
68
73
|
```text
|
|
69
|
-
[ Express App ] ──(HTTP POST)──> localhost:7777 (gloo-receiver)
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
+
[ Express App (Gloo SDK) ] ──(HTTP POST)──> localhost:7777 (gloo-receiver)
|
|
75
|
+
│
|
|
76
|
+
(Serves static UI files)
|
|
77
|
+
▼
|
|
78
|
+
localhost:7777 (gloo-ui in browser)
|
|
79
|
+
│
|
|
80
|
+
(WebSocket Stream)
|
|
81
|
+
▼
|
|
82
|
+
ws://localhost:7777
|
|
74
83
|
```
|
|
75
84
|
|
|
76
85
|
---
|