From 744a74155610529e339b60d5d59a8217524bbd01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Sch=C3=A4fer?= Date: Wed, 8 Oct 2025 01:01:33 +0200 Subject: [PATCH] docs(README): add Observability Quickstart section and link to docs/observability.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 42b306e..578fe3f 100644 --- a/README.md +++ b/README.md @@ -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.