Skip to content

Commit 3aa303f

Browse files
committed
chore: Documentation cleanup
1 parent 2602e5d commit 3aa303f

File tree

3 files changed

+3
-79
lines changed

3 files changed

+3
-79
lines changed

metro-ai-suite/live-video-analysis/live-metrics-service/README.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,6 @@ A reusable, containerized microservice for system metrics collection and real-ti
66

77
The Metrics Service provides a decoupled solution for collecting, relaying, and visualizing system metrics in real-time. It acts as a WebSocket relay between metrics collectors (like Telegraf) and dashboard clients, enabling live visualization of CPU, memory, GPU, and other system metrics.
88

9-
## Quick Start
10-
11-
### 1. Configure Environment Variables
12-
13-
Copy the example environment file and customize as needed:
14-
15-
```bash
16-
cp .env.example .env
17-
```
18-
19-
Edit `.env` to configure:
20-
- `METRICS_PORT` - Service port (default: 9090)
21-
- `LOG_LEVEL` - Logging verbosity (default: INFO)
22-
- `CORS_ORIGINS` - CORS allowed origins (default: *)
23-
24-
```bash
25-
export REGISTRY="intel/"
26-
export TAG="latest"
27-
docker compose up
28-
```
29-
30-
### 2. Verify the Service
31-
32-
```bash
33-
curl http://localhost:9090/health
34-
# Response: {"status": "healthy"}
35-
```
36-
379
## Documentation
3810

3911
Comprehensive documentation is available in the [user-guide](docs/user-guide/) directory:

metro-ai-suite/live-video-analysis/live-metrics-service/docs/user-guide/api-reference.md

Lines changed: 3 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -78,29 +78,10 @@ Detailed health with service status.
7878
{
7979
"status": "healthy",
8080
"collector_connected": true,
81-
"clients_connected": 3,
82-
"poller_active": false,
83-
"poller_target": null
81+
"clients_connected": 0
8482
}
8583
```
8684

87-
### `GET /api/metrics/status`
88-
89-
Full metrics collection status.
90-
91-
**Response:**
92-
93-
```json
94-
{
95-
"collector_connected": true,
96-
"clients_connected": 3,
97-
"poller": {
98-
"active": false,
99-
"target": null,
100-
"last_metrics": null
101-
}
102-
}
103-
```
10485

10586
### `GET /`
10687

@@ -117,35 +98,7 @@ Service information and available endpoints.
11798
"websocket_collector": "/ws/collector",
11899
"websocket_clients": "/ws/clients",
119100
"health": "/health",
120-
"health_detailed": "/api/health",
121-
"metrics_status": "/api/metrics/status"
101+
"health_detailed": "/api/health"
122102
}
123103
}
124-
```
125-
126-
## Configuration
127-
128-
### Environment Variables
129-
130-
| Variable | Default | Description |
131-
|----------|---------|-------------|
132-
| `METRICS_PORT` | `9090` | Port to run the service on |
133-
| `LOG_LEVEL` | `INFO` | Logging level: `DEBUG`, `INFO`, `WARNING`, `ERROR` |
134-
| `CORS_ORIGINS` | `*` | Comma-separated list of allowed CORS origins |
135-
| `TARGET_SERVICE_URL` | `` | Optional: URL of service to poll for metrics |
136-
| `METRICS_ENDPOINT` | `/api/metrics/status` | Endpoint path on target service for polling |
137-
| `POLL_INTERVAL_SECONDS` | `2` | Polling interval in seconds |
138-
139-
### Example Configuration
140-
141-
```bash
142-
# Production settings
143-
export METRICS_PORT=9090
144-
export LOG_LEVEL=WARNING
145-
export CORS_ORIGINS=https://dashboard.example.com,https://admin.example.com
146-
147-
# With optional polling enabled
148-
export TARGET_SERVICE_URL=http://my-app:8080
149-
export METRICS_ENDPOINT=/api/metrics
150-
export POLL_INTERVAL_SECONDS=2
151-
```
104+
```

metro-ai-suite/live-video-analysis/live-metrics-service/docs/user-guide/release-notes.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
- Single collector connection with policy enforcement
2020
- Multi-client broadcast support with unlimited connections
2121
- Health monitoring endpoints (`/health`, `/api/health`)
22-
- Metrics status endpoint (`/api/metrics/status`)
2322
- Configurable CORS support
2423
- Docker container with non-root user
2524
- Environment-based configuration

0 commit comments

Comments
 (0)