docs(README): add Observability Quickstart section and link to docs/observability.md

This commit is contained in:
Marc Schäfer
2025-10-08 01:01:33 +02:00
parent aea80200e0
commit 744a741556

View File

@@ -10,6 +10,7 @@ Newt is a fully user space [WireGuard](https://www.wireguard.com/) tunnel client
Newt is used with Pangolin and Gerbil as part of the larger system. See documentation below:
- [Full Documentation](https://docs.fossorial.io)
- Observability Quickstart: see docs/observability.md (Prometheus/OTel Collector setup, smoke tests)
## Preview
@@ -107,6 +108,13 @@ Default locations:
- **Windows**: `%PROGRAMDATA%\newt\newt-client\config.json`
- **Linux/Others**: `~/.config/newt-client/config.json`
## Observability Quickstart
For a quick start with Prometheus scraping and smoke checks, read the step-by-step guide in docs/observability.md. It includes:
- docker-compose.metrics.yml for direct /metrics scraping (recommended)
- docker-compose.metrics.collector.yml for the OTLP → Collector → Prometheus exporter path (no double-scrape)
- scripts/smoke-metrics.sh for basic verification
## Examples
**Note**: When both environment variables and CLI arguments are provided, CLI arguments take precedence.