Skip to content

[DOCS] Removed old metrices documentation from the README #1959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yogeshmpandey merged 2 commits into from
Mar 2, 2026
Merged

[DOCS] Removed old metrices documentation from the README #1959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3aa303f
chore: Documentation cleanup
yogeshmpandey Mar 2, 2026
60ae17d
fix(docs): update known issues and remove metrics endpoint reference
yogeshmpandey Mar 2, 2026
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
28 changes: 0 additions & 28 deletions metro-ai-suite/live-video-analysis/live-metrics-service/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,6 @@ A reusable, containerized microservice for system metrics collection and real-ti

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.

## Quick Start

### 1. Configure Environment Variables

Copy the example environment file and customize as needed:

```bash
cp .env.example .env
```

Edit `.env` to configure:
- `METRICS_PORT` - Service port (default: 9090)
- `LOG_LEVEL` - Logging verbosity (default: INFO)
- `CORS_ORIGINS` - CORS allowed origins (default: *)

```bash
export REGISTRY="intel/"
export TAG="latest"
docker compose up
```

### 2. Verify the Service

```bash
curl http://localhost:9090/health
# Response: {"status": "healthy"}
```

## Documentation

Comprehensive documentation is available in the [user-guide](docs/user-guide/) directory:
Expand Down
1 change: 0 additions & 1 deletion metro-ai-suite/live-video-analysis/live-metrics-service/compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ services:
- CORS_ORIGINS=${CORS_ORIGINS:-*}
# Optional: Configure target service polling
- TARGET_SERVICE_URL=${TARGET_SERVICE_URL:-}
- METRICS_ENDPOINT=${METRICS_ENDPOINT:-/api/metrics/status}
- POLL_INTERVAL_SECONDS=${POLL_INTERVAL_SECONDS:-2}
ports:
- "${METRICS_PORT:-9090}:9090"
Expand Down
53 changes: 3 additions & 50 deletions ...suite/live-video-analysis/live-metrics-service/docs/user-guide/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,29 +78,10 @@ Detailed health with service status.
{
"status": "healthy",
"collector_connected": true,
"clients_connected": 3,
"poller_active": false,
"poller_target": null
"clients_connected": 0
}
```

### `GET /api/metrics/status`

Full metrics collection status.

**Response:**

```json
{
"collector_connected": true,
"clients_connected": 3,
"poller": {
"active": false,
"target": null,
"last_metrics": null
}
}
```

### `GET /`

Expand All @@ -117,35 +98,7 @@ Service information and available endpoints.
"websocket_collector": "/ws/collector",
"websocket_clients": "/ws/clients",
"health": "/health",
"health_detailed": "/api/health",
"metrics_status": "/api/metrics/status"
"health_detailed": "/api/health"
}
}
```

## Configuration

### Environment Variables

| Variable | Default | Description |
|----------|---------|-------------|
| `METRICS_PORT` | `9090` | Port to run the service on |
| `LOG_LEVEL` | `INFO` | Logging level: `DEBUG`, `INFO`, `WARNING`, `ERROR` |
| `CORS_ORIGINS` | `*` | Comma-separated list of allowed CORS origins |
| `TARGET_SERVICE_URL` | `` | Optional: URL of service to poll for metrics |
| `METRICS_ENDPOINT` | `/api/metrics/status` | Endpoint path on target service for polling |
| `POLL_INTERVAL_SECONDS` | `2` | Polling interval in seconds |

### Example Configuration

```bash
# Production settings
export METRICS_PORT=9090
export LOG_LEVEL=WARNING
export CORS_ORIGINS=https://dashboard.example.com,https://admin.example.com

# With optional polling enabled
export TARGET_SERVICE_URL=http://my-app:8080
export METRICS_ENDPOINT=/api/metrics
export POLL_INTERVAL_SECONDS=2
```
```
8 changes: 2 additions & 6 deletions ...-suite/live-video-analysis/live-metrics-service/docs/user-guide/known-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@
**Symptom:** Client connects but receives no data.

**Solutions:**
1. Verify collector is connected: `curl http://localhost:9090/api/metrics/status`
2. Check if Telegraf is actually sending data
3. Ensure client is connected to `/ws/clients` (not `/ws/collector`)
1. Check if Telegraf is actually sending data
2. Ensure client is connected to `/ws/clients` (not `/ws/collector`)

### High Memory Usage

Expand Down Expand Up @@ -53,9 +52,6 @@ curl http://localhost:9090/health

# Detailed status
curl http://localhost:9090/api/health

# Metrics status
curl http://localhost:9090/api/metrics/status
```

## Limitations
Expand Down
1 change: 0 additions & 1 deletion ...suite/live-video-analysis/live-metrics-service/docs/user-guide/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
- Single collector connection with policy enforcement
- Multi-client broadcast support with unlimited connections
- Health monitoring endpoints (`/health`, `/api/health`)
- Metrics status endpoint (`/api/metrics/status`)
- Configurable CORS support
- Docker container with non-root user
- Environment-based configuration
Expand Down
Loading