Skip to content

Commit 50c0243

Browse files
committed
docs: [#246] Add comprehensive tracker verification guide
- Created tracker-verification.md with complete testing procedures - HTTP tracker endpoints (health, announce, scrape) - REST API endpoints (stats, metrics) - UDP tracker testing overview - Container and log verification - Updated main E2E manual README with service index - Added Torrust Tracker section (primary service) - Added Grafana Dashboards section - Reorganized service order for clarity - Verified all commands against live environment (manual-test-grafana) - Captured actual outputs for realistic examples - Fixed health check response format (Ok not ok) - Updated metrics format (JSON not text) - Added reverse proxy mode notes - Added bencode-related terms to spell check dictionary
1 parent 550d6f9 commit 50c0243

File tree

3 files changed

+599
-1
lines changed

3 files changed

+599
-1
lines changed

docs/e2e-testing/manual/README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,17 @@ ls data/manual-test 2>/dev/null || echo "Cleaned up successfully"
404404

405405
After deploying your environment, you may want to verify that specific services are working correctly. The following guides provide detailed verification steps for each supported service:
406406

407+
### Torrust Tracker
408+
409+
The tracker is the core service deployed by this tool. See the [Tracker Verification Guide](tracker-verification.md) for detailed steps to:
410+
411+
- Test HTTP tracker announce and scrape endpoints
412+
- Test UDP tracker functionality (overview and tooling)
413+
- Verify tracker REST API endpoints
414+
- Check health endpoints
415+
- Troubleshoot tracker-specific issues
416+
- Monitor tracker logs and performance
417+
407418
### MySQL Database
408419

409420
If your deployment includes MySQL as the database backend, see the [MySQL Verification Guide](mysql-verification.md) for detailed steps to:
@@ -425,9 +436,19 @@ If your deployment includes Prometheus for metrics collection (enabled by defaul
425436
- Query collected metrics
426437
- Troubleshoot Prometheus-specific issues
427438

439+
### Grafana Dashboards
440+
441+
If your deployment includes Grafana for metrics visualization, see the [Grafana Verification Guide](grafana-verification.md) for detailed steps to:
442+
443+
- Verify Grafana container health and connectivity
444+
- Check dashboard and datasource provisioning
445+
- Validate Prometheus datasource connection
446+
- Test end-to-end data flow (Tracker → Prometheus → Grafana)
447+
- Troubleshoot Grafana-specific issues
448+
428449
### Basic Tracker Verification
429450

430-
For basic tracker functionality without service-specific checks:
451+
For quick basic tracker functionality checks without the detailed guide:
431452

432453
```bash
433454
# Get the VM IP

0 commit comments

Comments
 (0)